Helper classs that implements most of BagOStuff for a backend. More...

Inherits Wikimedia\ObjectCache\BagOStuff.

Inherited by SqlBagOStuff, Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and Wikimedia\ObjectCache\RedisBagOStuff.

Collaboration diagram for Wikimedia\ObjectCache\MediumSpecificBagOStuff:

[legend]

Public Member Functions
	__construct (array $params=[])

	add ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	changeTTL ( $key, $exptime=0, $flags=0)
	Change the expiration on a key if it exists.

	changeTTLMulti (array $keys, $exptime, $flags=0)
	Change the expiration of multiple keys that exist.

	delete ( $key, $flags=0)
	Delete an item if it exists.

	deleteMulti (array $keys, $flags=0)
	Delete a batch of items.

	deleteObjectsExpiringBefore ( $timestamp, ?callable $progress=null, $limit=INF, ?string $tag=null)
	Delete all objects expiring before a certain date.

	get ( $key, $flags=0)
	Get an item with the given key.

	getMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	getQoS ( $flag)

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

	incrWithInit ( $key, $exptime, $step=1, $init=null, $flags=0)
	Increase the value of the given key (no TTL change) if it exists or create it otherwise.

	lock ( $key, $timeout=6, $exptime=6, $rclass='')

	merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one)

	set ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	setMulti (array $valueByKey, $exptime=0, $flags=0)
	Batch insertion/replace.

	unlock ( $key)
	Release an advisory lock on a key string.

Public Member Functions inherited from Wikimedia\ObjectCache\BagOStuff
	clearLastError ()
	Clear the "last error" registry.

	getCurrentTime ()

	getLastError ( $watchPoint=0)
	Get the "last error" registry.

	getLogger ()

	getScopedLock ( $key, $timeout=6, $exptime=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.

	getWithSetCallback ( $key, $exptime, $callback, $flags=0)
	Get an item, regenerating and setting it if not found.

	isKeyGlobal ( $key)
	Check whether a cache key is in the global keyspace.

	makeGlobalKey ( $keygroup,... $components)
	Make a cache key from the given components, in the "global" keyspace.

	makeKey ( $keygroup,... $components)
	Make a cache key from the given components, in the default keyspace.

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

	watchErrors ()
	Get a "watch point" token that can be used to get the "last error" to occur after now.

Protected Member Functions
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Set an item if the current CAS token matches the provided CAS token.

	debug ( $text)

	doAdd ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Set an item if the current CAS token matches the provided CAS token.

	doChangeTTL ( $key, $exptime, $flags)

	doChangeTTLMulti (array $keys, $exptime, $flags=0)

	doDelete ( $key, $flags=0)
	Delete an item.

	doDeleteMulti (array $keys, $flags=0)

	doGet ( $key, $flags=0, &$casToken=null)
	Get an item.

	doGetMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	doIncrWithInit ( $key, $exptime, $step, $init, $flags)

	doLock ( $key, $timeout, $exptime)

	doSet ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	doSetMulti (array $data, $exptime=0, $flags=0)

	doUnlock ( $key)

	getExpirationAsTimestamp ( $exptime)
	Convert an optionally relative timestamp to an absolute time.

	getExpirationAsTTL ( $exptime)
	Convert an optionally absolute expiry time to a relative time.

	getSerialized ( $value, $key)
	Get the serialized form a value, logging a warning if it involves custom classes.

	isInteger ( $value)
	Check if a value is an integer.

	isRelativeExpiration ( $exptime)

	makeLockKey ( $key)

	makeValueOrSegmentList ( $key, $value, $exptime, $flags, &$ok)
	Make the entry to store at a key (inline or segment list), storing any segments.

	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)

	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key.

	serialize ( $value)

	tokensMatch ( $value, $otherValue)

	unserialize ( $value)

	updateOpStats (string $op, array $keyInfo)

Protected Member Functions inherited from Wikimedia\ObjectCache\BagOStuff
	fieldHasFlags ( $field, $flags)

	makeKeyInternal ( $keyspace, $components)
	Make a cache key for the given keyspace and components.

	mergeFlagMaps (array $bags)
	Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

	proxyCall (string $method, int $arg0Sig, int $resSig, array $genericArgs, BagOStuff $wrapper)
	Call a method on behalf of wrapper BagOStuff instance.

	requireConvertGenericKey ()
	Whether ::proxyCall() must re-encode cache keys before calling read/write methods.

	setLastError ( $error)
	Set the "last error" registry due to a problem encountered during an attempted operation.

Protected Attributes
array< string, array >	$locks = []
	Map of (key => (class LOCK_* constant => value)

float	$maxLockSendDelay = 0.05
	Seconds; maximum expected seconds for a lock ping to reach the backend.

int	$segmentationSize
	Bytes; chunk size of segmented cache values.

int	$segmentedValueMaxSize
	Bytes; maximum total size of a segmented cache value.

const	LOCK_DEPTH = 1

const	LOCK_EXPIRY = 3

const	LOCK_RCLASS = 0

const	LOCK_TIME = 2

const	METRIC_OP_ADD = 'add'

const	METRIC_OP_CAS = 'cas'

const	METRIC_OP_CHANGE_TTL = 'change_ttl'

const	METRIC_OP_DECR = 'decr'

const	METRIC_OP_DELETE = 'delete'

const	METRIC_OP_GET = 'get'

const	METRIC_OP_INCR = 'incr'

const	METRIC_OP_SET = 'set'

const	PASS_BY_REF = -1
	Idiom for doGet() to return extra information by reference.

Protected Attributes inherited from Wikimedia\ObjectCache\BagOStuff
callable null	$asyncHandler

int[]	$attrMap = []
	Map of (BagOStuff:ATTR_* constant => BagOStuff:QOS_* constant)

string	$keyspace
	Default keyspace; used by makeKey()

int	$lastError = self::ERR_NONE
	BagOStuff:ERR_* constant of the last error that occurred.

int	$lastErrorId = 0
	Error event sequence number of the last error that occurred.

LoggerInterface	$logger

StatsFactory	$stats

Additional Inherited Members
Public Attributes inherited from Wikimedia\ObjectCache\BagOStuff
const	MAX_CONFLICTS_ONE = 1
	Abort after the first merge conflict.

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.

const	READ_VERIFIED = 2
	Promise that the caller handles detection of staleness.

const	WRITE_ALLOW_SEGMENTS = 16
	Allow partitioning of the value if it is a large string.

const	WRITE_BACKGROUND = 64
	If supported, do not block on write operation completion; instead, treat writes as succesful based on whether they could be buffered.

const	WRITE_CACHE_ONLY = 8
	Bitfield constants for set()/merge(); these are only advisory.

const	WRITE_PRUNE_SEGMENTS = self::WRITE_ALLOW_SEGMENTS
	Delete all the segments if the value is partitioned.

Public Attributes inherited from Wikimedia\ObjectCache\StorageAwareness
const	ATTR_DURABILITY = 2
	Durability of writes; see QOS_DURABILITY_* (higher means stronger)

const	ATTR_EMULATION = 1

const	ERR_NO_RESPONSE = 1
	Storage medium failed to yield a complete response to an operation.

const	ERR_NONE = 0
	No storage medium error.

const	ERR_UNEXPECTED = 3
	Storage medium operation failed due to usage limitations or an I/O error.

const	ERR_UNREACHABLE = 2
	Storage medium could not be reached to establish a connection.

const	QOS_DURABILITY_DISK = 4
	Data is saved to disk and writes do not usually block on fsync()

const	QOS_DURABILITY_NONE = 1
	Data is never saved to begin with (blackhole store)

const	QOS_DURABILITY_RDBMS = 5
	Data is saved to disk and writes usually block on fsync(), like a standard RDBMS.

const	QOS_DURABILITY_SCRIPT = 2
	Data is lost at the end of the current web request or CLI script.

const	QOS_DURABILITY_SERVICE = 3
	Data is lost once the service storing the data restarts.

const	QOS_UNKNOWN = INF
	Generic "unknown" value; useful for comparisons (always "good enough")

Static Protected Attributes inherited from Wikimedia\ObjectCache\BagOStuff
static int	$nextErrorMonitorId = 1
	Next sequence number to use for watch/error events.

Detailed Description

Helper classs that implements most of BagOStuff for a backend.

This should be used by concrete implementations only. Wrapper classes that proxy another BagOStuff should extend and implement BagOStuff directly.

Since: 1.34

Definition at line 36 of file MediumSpecificBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::__construct ( array $params = [] )

See also

BagOStuff::__construct() Additional $params options include:

logger: Psr\Log\LoggerInterface instance
reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
segmentationSize: The chunk size, in bytes, of segmented values. The value should not exceed the maximum size of values in the storage backend, as configured by the site administrator.
segmentedValueMaxSize: The maximum total size, in bytes, of segmented values. This should be configured to a reasonable size give the site traffic and the amount of I/O between application and cache servers that the network can handle.

Parameters

array $params

@phpcs:ignore Generic.Files.LineLength

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Reimplemented in Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\APCUBagOStuff, and Wikimedia\ObjectCache\EmptyBagOStuff.

Definition at line 92 of file MediumSpecificBagOStuff.php.

References $params.

Member Function Documentation

◆ add()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::add	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

Insert an item if it does not already exist.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success (item created)

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 226 of file MediumSpecificBagOStuff.php.

Referenced by MemcLockManager\acquireMutexes().

◆ cas()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = 0,
		$flags = 0 )

protected

Set an item if the current CAS token matches the provided CAS token.

Parameters

mixed	$casToken	Only set the item if it still has this CAS token
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Definition at line 342 of file MediumSpecificBagOStuff.php.

◆ changeTTL()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::changeTTL	(	$key,
		$exptime = 0,
		$flags = 0 )

Change the expiration on a key if it exists.

If an expiry in the past is given then the key will immediately be expired

For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.

Parameters

string	$key
int	$exptime	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success Returns false on failure or if the item does not exist

Since: 1.28

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 444 of file MediumSpecificBagOStuff.php.

◆ changeTTLMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::changeTTLMulti	(	array	$keys,
			$exptime,
			$flags = 0 )

Change the expiration of multiple keys that exist.

Parameters

string[]	$keys	List of keys
int	$exptime	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Since: 1.34

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 782 of file MediumSpecificBagOStuff.php.

◆ debug()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::debug ( $text )

protected

Parameters

string $text

Definition at line 1119 of file MediumSpecificBagOStuff.php.

◆ delete()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::delete	(		$key,
			$flags = 0 )

Delete an item if it exists.

For large values set with WRITE_ALLOW_SEGMENTS, this only deletes the placeholder key with the segment list. To delete the underlying blobs, include WRITE_ALLOW_SEGMENTS in the flags for delete() as well. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in storage.

The reason that this is not done automatically, is that to delete underlying blobs, requires first fetching the current segment list. Given that 99% of keys don't use WRITE_ALLOW_SEGMENTS, this would be wasteful.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success (item deleted or not found)

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 191 of file MediumSpecificBagOStuff.php.

References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doDelete(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\doGet(), Wikimedia\ObjectCache\BagOStuff\fieldHasFlags(), Wikimedia\ObjectCache\SerializedValueContainer\isSegmented(), Wikimedia\ObjectCache\BagOStuff\makeGlobalKey(), and Wikimedia\ObjectCache\SerializedValueContainer\SEGMENTED_HASHES.

Referenced by MemcLockManager\releaseMutexes().

◆ deleteMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::deleteMulti	(	array	$keys,
			$flags = 0 )

Delete a batch of items.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

WRITE_BACKGROUND can be used for bulk deletion where the response is not vital

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success (items deleted and/or not found)

Since: 1.33

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 748 of file MediumSpecificBagOStuff.php.

◆ deleteObjectsExpiringBefore()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::deleteObjectsExpiringBefore	(		$timestamp,
		?callable	$progress = null,
			$limit = INF,
		?string	$tag = null )

Delete all objects expiring before a certain date.

Parameters

string \| int	$timestamp	The reference date in MW or TS_UNIX format
callable \| null	$progress	Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional]
int \| float	$limit	Maximum number of keys to delete [default: INF]
string \| null	$tag	Tag to purge a single shard only. This is only supported when server tags are used in configuration.

Returns: bool Success; false if unimplemented

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Reimplemented in SqlBagOStuff.

Definition at line 657 of file MediumSpecificBagOStuff.php.

◆ doAdd()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doAdd	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

abstractprotected

Insert an item if it does not already exist.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and SqlBagOStuff.

◆ doCas()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doCas	(	$casToken,
		$key,
		$value,
		$exptime = 0,
		$flags = 0 )

protected

Set an item if the current CAS token matches the provided CAS token.

Parameters

mixed	$casToken	CAS token from an existing version of the key
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 370 of file MediumSpecificBagOStuff.php.

References $success.

◆ doChangeTTL()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doChangeTTL	(	$key,
		$exptime,
		$flags )

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.

Definition at line 455 of file MediumSpecificBagOStuff.php.

◆ doChangeTTLMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doChangeTTLMulti	(	array	$keys,
			$exptime,
			$flags = 0 )

protected

Parameters

string[]	$keys	List of keys
int	$exptime	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.

Definition at line 793 of file MediumSpecificBagOStuff.php.

◆ doDelete()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doDelete	(		$key,
			$flags = 0 )

abstractprotected

Delete an item.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool True if the item was deleted or not found, false on failure

Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and SqlBagOStuff.

Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\delete().

◆ doDeleteMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doDeleteMulti	(	array	$keys,
			$flags = 0 )

protected

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.

Definition at line 762 of file MediumSpecificBagOStuff.php.

◆ doGet()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doGet	(		$key,
			$flags = 0,
		&	$casToken = null )

abstractprotected

Get an item.

The CAS token should be null if the key does not exist or the value is corrupt

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed	&$casToken	CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned]

Returns: mixed Returns false on failure or if the item does not exist

Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and SqlBagOStuff.

Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\delete(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\get().

◆ doGetMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doGetMulti	(	array	$keys,
			$flags = 0 )

protected

Get an associative array containing the item for each of the keys that have items.

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array Map of (key => value) for existing keys; preserves the order of $keys

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.

Definition at line 700 of file MediumSpecificBagOStuff.php.

◆ doIncrWithInit()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doIncrWithInit	(	$key,
		$exptime,
		$step,
		$init,
		$flags )

abstractprotected

Parameters

string	$key
int	$exptime
int	$step
int	$init
int	$flags

Returns: int|bool New value or false on failure

Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and SqlBagOStuff.

◆ doLock()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doLock	(	$key,
		$timeout,
		$exptime )

protected

See also: MediumSpecificBagOStuff::lock()

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$exptime	Lock time-to-live 1 day maximum [optional]

Returns: float|null UNIX timestamp of acquisition; null on failure

Reimplemented in SqlBagOStuff.

Definition at line 544 of file MediumSpecificBagOStuff.php.

◆ doSet()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doSet	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

abstractprotected

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, and SqlBagOStuff.

Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\set().

◆ doSetMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doSetMulti	(	array	$data,
			$exptime = 0,
			$flags = 0 )

protected

Parameters

mixed[]	$data	Map of (key => value)
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.

Definition at line 739 of file MediumSpecificBagOStuff.php.

◆ doUnlock()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::doUnlock ( $key )

protected

See also: MediumSpecificBagOStuff::unlock()

Parameters

string $key

Returns: bool Success

Reimplemented in SqlBagOStuff.

Definition at line 620 of file MediumSpecificBagOStuff.php.

◆ get()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::get	(		$key,
			$flags = 0 )

Get an item with the given key.

If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

Returns: mixed Returns false on failure or if the item does not exist

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 119 of file MediumSpecificBagOStuff.php.

References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doGet(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\resolveSegments().

◆ getExpirationAsTimestamp()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getExpirationAsTimestamp ( $exptime )

finalprotected

Convert an optionally relative timestamp to an absolute time.

The input value will be cast to an integer and interpreted as follows:

zero: no expiry; return zero (e.g. TTL_INDEFINITE)
negative: relative TTL; return UNIX timestamp offset by this value
positive (< 10 years): relative TTL; return UNIX timestamp offset by this value
positive (>= 10 years): absolute UNIX timestamp; return this value

Parameters

int $exptime

Returns: int Expiration timestamp or TTL_INDEFINITE for indefinite

Since: 1.34

Definition at line 946 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), and Wikimedia\ObjectCache\HashBagOStuff\doSet().

◆ getExpirationAsTTL()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getExpirationAsTTL ( $exptime )

finalprotected

Convert an optionally absolute expiry time to a relative time.

If an absolute time is specified which is in the past, use a short expiry time.

The input value will be cast to an integer and interpreted as follows:

zero: no expiry; return zero (e.g. TTL_INDEFINITE)
negative: relative TTL; return a short expiry time (1 second)
positive (< 10 years): relative TTL; return this value
positive (>= 10 years): absolute UNIX timestamp; return offset to current time

Parameters

int $exptime

Returns: int Relative TTL or TTL_INDEFINITE for indefinite

Since: 1.34

Definition at line 971 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\APCUBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\APCUBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RedisBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\APCUBagOStuff\doSet(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().

◆ getMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getMulti	(	array	$keys,
			$flags = 0 )

Get an associative array containing the item for each of the keys that have items.

Parameters

string[]	$keys	List of keys; can be a map of (unused => key) for convenience
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: mixed[] Map of (key => value) for existing keys; preserves the order of $keys

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 674 of file MediumSpecificBagOStuff.php.

◆ getQoS()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getQoS ( $flag )

Parameters

int $flag BagOStuff::ATTR_* constant

Returns: int BagOStuff:QOS_* constant

Since: 1.28

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 1000 of file MediumSpecificBagOStuff.php.

◆ getSegmentationSize()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getSegmentationSize ( )

Deprecated: since 1.43, not used anywhere.

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 1007 of file MediumSpecificBagOStuff.php.

References wfDeprecated().

◆ getSegmentedValueMaxSize()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getSegmentedValueMaxSize ( )

Deprecated: since 1.43, not used anywhere.

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 1016 of file MediumSpecificBagOStuff.php.

References wfDeprecated().

◆ getSerialized()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::getSerialized	(		$value,
			$key )

protected

Get the serialized form a value, logging a warning if it involves custom classes.

Parameters

mixed	$value
string	$key

Returns: string|int String/integer representation of value

Since: 1.35

Definition at line 1031 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().

◆ incrWithInit()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::incrWithInit	(	$key,
		$exptime,
		$step = 1,
		$init = null,
		$flags = 0 )

Increase the value of the given key (no TTL change) if it exists or create it otherwise.

This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $step) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $step.

The new value is returned, except if the WRITE_BACKGROUND flag is given, in which case the handler may choose to return true to indicate that the operation has been dispatched.

Parameters

string	$key	Key built via makeKey() or makeGlobalKey()
int	$exptime	Time-to-live (in seconds) or a UNIX timestamp expiration
int	$step	Amount to increase the key value by [default: 1]
int \| null	$init	Value to initialize the key to if it does not exist [default: $step]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value (or true if asynchronous) on success; false on failure

Since: 1.24

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 481 of file MediumSpecificBagOStuff.php.

◆ isInteger()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::isInteger ( $value )

finalprotected

Check if a value is an integer.

Parameters

mixed $value

Returns: bool

Definition at line 988 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\HashBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RESTBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\unserialize(), and Wikimedia\ObjectCache\MemcachedPhpBagOStuff\unserialize().

◆ isRelativeExpiration()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::isRelativeExpiration ( $exptime )

finalprotected

Parameters

int | float $exptime

Returns: bool Whether the expiry is non-infinite, and, negative or not a UNIX timestamp

Since: 1.34

Definition at line 928 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), and Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti().

◆ lock()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::lock	(	$key,
		$timeout = 6,
		$exptime = 6,
		$rclass = '' )

Parameters

string	$key
int	$timeout
int	$exptime
string	$rclass

Returns: bool

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 507 of file MediumSpecificBagOStuff.php.

◆ makeLockKey()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::makeLockKey ( $key )

protected

Parameters

string $key

Returns: string

Definition at line 653 of file MediumSpecificBagOStuff.php.

◆ makeValueOrSegmentList()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::makeValueOrSegmentList	(		$key,
			$value,
			$exptime,
			$flags,
		&	$ok )

finalprotected

Make the entry to store at a key (inline or segment list), storing any segments.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags
mixed \| null	&$ok	Whether the entry is usable (e.g. no missing segments) [returned]

Returns: mixed The entry (inline value, wrapped inline value, or wrapped segment list)

Since: 1.34

Definition at line 887 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\set().

◆ merge()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::merge	(		$key,
		callable	$callback,
			$exptime = 0,
			$attempts = 10,
			$flags = 0 )

Merge changes into the existing cache value (possibly creating a new one)

The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overridden in the callback. Nothing is stored nor deleted if the callback returns false.

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Reimplemented in Wikimedia\ObjectCache\EmptyBagOStuff.

Definition at line 262 of file MediumSpecificBagOStuff.php.

◆ mergeViaCas()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::mergeViaCas	(		$key,
		callable	$callback,
			$exptime,
			$attempts,
			$flags )

finalprotected

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

See also: BagOStuff::merge()

Definition at line 276 of file MediumSpecificBagOStuff.php.

References $success.

◆ resolveSegments()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::resolveSegments	(		$key,
			$mainValue )

finalprotected

Get and reassemble the chunks of blob at the given key.

Parameters

string	$key
mixed	$mainValue

Returns: string|null|bool The combined string, false if missing, null on error

Definition at line 810 of file MediumSpecificBagOStuff.php.

References Wikimedia\ObjectCache\SerializedValueContainer\isSegmented(), and Wikimedia\ObjectCache\SerializedValueContainer\SEGMENTED_HASHES.

Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\get().

◆ serialize()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int|false String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 1102 of file MediumSpecificBagOStuff.php.

◆ set()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::set	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants If setting WRITE_ALLOW_SEGMENTS, remember to also set it in any delete() calls.

Returns: bool Success

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 172 of file MediumSpecificBagOStuff.php.

References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doSet(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\makeValueOrSegmentList().

◆ setMulti()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::setMulti	(	array	$valueByKey,
			$exptime = 0,
			$flags = 0 )

Batch insertion/replace.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

Parameters

mixed[]	$valueByKey	Map of (key => value)
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Since: 1.24

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 724 of file MediumSpecificBagOStuff.php.

◆ tokensMatch()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::tokensMatch	(		$value,
			$otherValue )

finalprotected

Parameters

mixed	$value	CAS token for an existing key
mixed	$otherValue	CAS token for an existing key

Returns: bool Whether the two tokens match

Definition at line 409 of file MediumSpecificBagOStuff.php.

◆ unlock()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 587 of file MediumSpecificBagOStuff.php.

◆ unserialize()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::unserialize ( $value )

protected

Parameters

string | int | false $value

Returns: mixed Original value or false on error

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 1112 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doGet(), and Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti().

◆ updateOpStats()

Wikimedia\ObjectCache\MediumSpecificBagOStuff::updateOpStats	(	string	$op,
		array	$keyInfo )

protected

Parameters

string	$op	Operation name as a MediumSpecificBagOStuff::METRIC_OP_* constant
	array<int,string>\|array<string,int[]>	$keyInfo Key list, if payload sizes are not applicable, otherwise, map of (key => (send payload size, receive payload size)); send and receive sizes are 0 where not applicable and receive sizes are "false" for keys that were not found during read operations

Definition at line 1145 of file MediumSpecificBagOStuff.php.

Member Data Documentation

◆ $locks

array<string,array> Wikimedia\ObjectCache\MediumSpecificBagOStuff::$locks = []

protected

Map of (key => (class LOCK_* constant => value)

Definition at line 38 of file MediumSpecificBagOStuff.php.

◆ $maxLockSendDelay

float Wikimedia\ObjectCache\MediumSpecificBagOStuff::$maxLockSendDelay = 0.05

protected

Seconds; maximum expected seconds for a lock ping to reach the backend.

Definition at line 45 of file MediumSpecificBagOStuff.php.

◆ $segmentationSize

int Wikimedia\ObjectCache\MediumSpecificBagOStuff::$segmentationSize

protected

Bytes; chunk size of segmented cache values.

Definition at line 40 of file MediumSpecificBagOStuff.php.

◆ $segmentedValueMaxSize

int Wikimedia\ObjectCache\MediumSpecificBagOStuff::$segmentedValueMaxSize

protected

Bytes; maximum total size of a segmented cache value.

Definition at line 42 of file MediumSpecificBagOStuff.php.

◆ LOCK_DEPTH

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::LOCK_DEPTH = 1

protected

Definition at line 70 of file MediumSpecificBagOStuff.php.

◆ LOCK_EXPIRY

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::LOCK_EXPIRY = 3

protected

Definition at line 72 of file MediumSpecificBagOStuff.php.

◆ LOCK_RCLASS

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::LOCK_RCLASS = 0

protected

Definition at line 69 of file MediumSpecificBagOStuff.php.

◆ LOCK_TIME

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::LOCK_TIME = 2

protected

Definition at line 71 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_ADD

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_ADD = 'add'

protected

Definition at line 64 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_CAS

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_CAS = 'cas'

protected

Definition at line 67 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_CHANGE_TTL

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_CHANGE_TTL = 'change_ttl'

protected

Definition at line 63 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_DECR

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_DECR = 'decr'

protected

Definition at line 66 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_DELETE

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_DELETE = 'delete'

protected

Definition at line 62 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_GET

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_GET = 'get'

protected

Definition at line 60 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_INCR

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_INCR = 'incr'

protected

Definition at line 65 of file MediumSpecificBagOStuff.php.

◆ METRIC_OP_SET

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::METRIC_OP_SET = 'set'

protected

Definition at line 61 of file MediumSpecificBagOStuff.php.

◆ PASS_BY_REF

const Wikimedia\ObjectCache\MediumSpecificBagOStuff::PASS_BY_REF = -1

protected

Idiom for doGet() to return extra information by reference.

Definition at line 58 of file MediumSpecificBagOStuff.php.

Referenced by Wikimedia\ObjectCache\APCUBagOStuff\doGet(), Wikimedia\ObjectCache\HashBagOStuff\doGet(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doGet(), Wikimedia\ObjectCache\MemcachedPhpBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), and Wikimedia\ObjectCache\RESTBagOStuff\doGet().

The documentation for this class was generated from the following file:

includes/libs/objectcache/MediumSpecificBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ cas()

◆ changeTTL()

◆ changeTTLMulti()

◆ debug()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doChangeTTLMulti()

◆ doDelete()

◆ doDeleteMulti()

◆ doGet()

◆ doGetMulti()

◆ doIncrWithInit()

◆ doLock()

◆ doSet()

◆ doSetMulti()

◆ doUnlock()

◆ get()

◆ getExpirationAsTimestamp()

◆ getExpirationAsTTL()

◆ getMulti()

◆ getQoS()

◆ getSegmentationSize()

◆ getSegmentedValueMaxSize()

◆ getSerialized()

◆ incrWithInit()

◆ isInteger()

◆ isRelativeExpiration()

◆ lock()

◆ makeLockKey()

◆ makeValueOrSegmentList()

◆ merge()

◆ mergeViaCas()

◆ resolveSegments()

◆ serialize()

◆ set()

◆ setMulti()

◆ tokensMatch()

◆ unlock()

◆ unserialize()

◆ updateOpStats()

Member Data Documentation

◆ $locks

◆ $maxLockSendDelay

◆ $segmentationSize

◆ $segmentedValueMaxSize

◆ LOCK_DEPTH

◆ LOCK_EXPIRY

◆ LOCK_RCLASS

◆ LOCK_TIME

◆ METRIC_OP_ADD

◆ METRIC_OP_CAS

◆ METRIC_OP_CHANGE_TTL

◆ METRIC_OP_DECR

◆ METRIC_OP_DELETE

◆ METRIC_OP_GET

◆ METRIC_OP_INCR

◆ METRIC_OP_SET

◆ PASS_BY_REF