Class representing a cache/ephemeral data store. More...

Inheritance diagram for BagOStuff:

[legend]

Collaboration diagram for BagOStuff:

Public Member Functions
	__construct (array $params=[])
	$params include: More...

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

	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls. More...

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

	clearLastError ()
	Clear the "last error" registry. More...

	decr ( $key, $value=1)
	Decrease stored value of $key by $value while preserving its TTL. More...

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

	deleteMulti (array $keys, $flags=0)
	Batch deletion. More...

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete all objects expiring before a certain date. More...

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

	getCurrentTime ()

	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually. More...

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

	getQoS ( $flag)

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

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

	getWithSetCallback ( $key, $ttl, $callback, $flags=0)
	Get an item with the given key, regenerating and setting it if not found. More...

	incr ( $key, $value=1)
	Increase stored value of $key by $value while preserving its TTL. More...

	incrWithInit ( $key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL. More...

	lock ( $key, $timeout=6, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string. More...

	makeGlobalKey ( $class, $component=null)
	Make a global cache key. More...

	makeKey ( $class, $component=null)
	Make a cache key, scoped to this instance's keyspace. More...

	makeKeyInternal ( $keyspace, $args)
	Construct a cache key. More...

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

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

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

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

Public Attributes
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti() More...

const	READ_VERIFIED = 2

const	WRITE_ALLOW_SEGMENTS = 16

const	WRITE_CACHE_ONLY = 8

const	WRITE_PRUNE_SEGMENTS = 32

const	WRITE_SYNC = 4
	Bitfield constants for set()/merge() More...

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	QOS_EMULATION_SQL = 1

const	QOS_SYNCWRITES_BE = 2

const	QOS_SYNCWRITES_NONE = 1

const	QOS_SYNCWRITES_QC = 3

const	QOS_SYNCWRITES_SS = 4

const	QOS_UNKNOWN = INF

const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_PROC_LONG = 30

const	TTL_PROC_SHORT = 3

const	TTL_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Member Functions
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item. More...

	convertToExpiry ( $exptime)
	Convert an optionally relative time to an absolute time. More...

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

	debug ( $text)

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

	doGet ( $key, $flags=0, &$casToken=null)

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

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

	expiryIsRelative ( $exptime)

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

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

	mergeViaCas ( $key, $callback, $exptime=0, $attempts=10, $flags=0)

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

	serialize ( $value)

	setLastError ( $err)
	Set the "last error" registry. More...

	unserialize ( $value)

Protected Attributes
callable null	$asyncHandler

int []	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant) More...

callable []	$busyCallbacks = []

string	$keyspace = 'local'

int	$lastError = self::ERR_NONE
	ERR_* class constant. More...

array []	$locks = []
	Lock tracking. More...

LoggerInterface	$logger

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

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

int	$syncTimeout
	Seconds. More...

Private Member Functions
	trackDuplicateKeys ( $key)
	Track the number of times that a given key has been used. More...

Private Attributes
bool	$debugMode = false

bool	$dupeTrackScheduled = false

array	$duplicateKeyLookups = []

bool	$reportDupes = false

float null	$wallClockOverride

Detailed Description

Class representing a cache/ephemeral data store.

This interface is intended to be more or less compatible with the PHP memcached client.

Instances of this class should be created with an intended access scope, such as:

a) A single PHP thread on a server (e.g. stored in a PHP variable)
b) A single application server (e.g. stored in APC or sqlite)
c) All application servers in datacenter (e.g. stored in memcached or mysql)
d) All application servers in all datacenters (e.g. stored via mcrouter or dynomite)

Callers should use the proper factory methods that yield BagOStuff instances. Site admins should make sure the configuration for those factory methods matches their access scope. BagOStuff subclasses have widely varying levels of support for replication features.

For any given instance, methods like lock(), unlock(), merge(), and set() with WRITE_SYNC should semantically operate over its entire access scope; any nodes/threads in that scope should serialize appropriately when using them. Likewise, a call to get() with READ_LATEST from one node in its access scope should reflect the prior changes of any other node its access scope. Any get() should reflect the changes of any prior set() with WRITE_SYNC.

Subclasses should override the default "segmentationSize" field with an appropriate value. The value should not be larger than what the storage backend (by default) supports. It also should be roughly informed by common performance bottlenecks (e.g. values over a certain size having poor scalability). The same goes for the "segmentedValueMaxSize" member, which limits the maximum size and chunk count (indirectly) of values.

Definition at line 64 of file BagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

BagOStuff::__construct ( array $params = [] )

$params include:

logger: Psr\Log\LoggerInterface instance
keyspace: Default keyspace for $this->makeKey()
asyncHandler: Callable to use for scheduling tasks after the web request ends. In CLI mode, it should run the task immediately.
reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
syncTimeout: How long to wait with WRITE_SYNC in seconds.
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

Definition at line 129 of file BagOStuff.php.

References $params, null, and setLogger().

Member Function Documentation

◆ add()

BagOStuff::add	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

abstract

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

Referenced by MemcLockManager\acquireMutexes(), delete(), incrWithInit(), lock(), and mergeViaCas().

◆ addBusyCallback()

BagOStuff::addBusyCallback ( callable $workCallback )

Let a callback be run to avoid wasting time on special blocking calls.

The callbacks may or may not be called ever, in any particular order. They are likely to be invoked when something WRITE_SYNC is used used. They should follow a caching pattern as shown below, so that any code using the work will get it's result no matter what happens.

$result = null;
$workCallback = function () use ( &$result ) {
    if ( !$result ) {
        $result = ....
    }
    return $result;
}

Parameters

callable $workCallback

Since: 1.28

Definition at line 868 of file BagOStuff.php.

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ cas()

BagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

protected

Check and set an item.

Parameters

mixed	$casToken
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 465 of file BagOStuff.php.

References $success, $value, doGet(), lock(), null, and unlock().

Referenced by mergeViaCas().

◆ changeTTL()

BagOStuff::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

Definition at line 505 of file BagOStuff.php.

References $blob, convertToExpiry(), doDelete(), doGet(), doSet(), getCurrentTime(), lock(), and unlock().

◆ clearLastError()

BagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Definition at line 835 of file BagOStuff.php.

Referenced by incrWithInit(), lock(), and mergeViaCas().

◆ convertToExpiry()

BagOStuff::convertToExpiry ( $exptime )

protected

Convert an optionally relative time to an absolute time.

Parameters

int $exptime

Returns: int

Definition at line 896 of file BagOStuff.php.

References expiryIsRelative(), and getCurrentTime().

Referenced by SqlBagOStuff\cas(), RedisBagOStuff\changeTTL(), changeTTL(), SqlBagOStuff\changeTTL(), HashBagOStuff\doSet(), and SqlBagOStuff\insertMulti().

◆ convertToRelative()

BagOStuff::convertToRelative ( $exptime )

protected

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.

Parameters

int $exptime

Returns: int

Definition at line 911 of file BagOStuff.php.

References getCurrentTime().

Referenced by RedisBagOStuff\add(), RedisBagOStuff\changeTTL(), RedisBagOStuff\doSet(), and RedisBagOStuff\setMulti().

◆ debug()

BagOStuff::debug ( $text )

protected

◆ decr()

BagOStuff::decr	(	$key,
		$value = `1`
	)

Decrease stored value of $key by $value while preserving its TTL.

Parameters

string	$key
int	$value	Value to subtract from $key (default: 1) [optional]

Returns: int|bool New value or false on failure

Definition at line 754 of file BagOStuff.php.

References $value, and incr().

◆ delete()

BagOStuff::delete	(	$key,
		$flags = `0`
	)

Delete an item.

For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.

Parameters

string $key

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

Parameters

int $flags Bitfield of BagOStuff::WRITE_* constants

Definition at line 333 of file BagOStuff.php.

References $value, add(), deleteMulti(), doDelete(), doGet(), SerializedValueContainer\isSegmented(), makeGlobalKey(), SerializedValueContainer\SEGMENTED_HASHES, and use.

Referenced by MemcLockManager\releaseMutexes().

◆ deleteMulti()

BagOStuff::deleteMulti	(	array	$keys,
			$flags = `0`
	)

Batch deletion.

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

Parameters

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

Returns: bool Success

Since: 1.33

Definition at line 731 of file BagOStuff.php.

References $res, $value, as, doDelete(), and incr().

Referenced by delete().

◆ deleteObjectsExpiringBefore()

BagOStuff::deleteObjectsExpiringBefore	(	$date,
		$progressCallback = `false`
	)

Delete all objects expiring before a certain date.

Parameters

string	$date	The reference date in MW format
callable \| bool	$progressCallback	Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter.

Returns: bool Success, false if unimplemented

Definition at line 658 of file BagOStuff.php.

◆ doDelete()

BagOStuff::doDelete	(	$key,
		$flags = `0`
	)

abstractprotected

Delete an item.

Parameters

string $key

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

Parameters

int $flags Bitfield of BagOStuff::WRITE_* constants

Referenced by changeTTL(), delete(), deleteMulti(), and unlock().

◆ doGet()

BagOStuff::doGet	(		$key,
			$flags = `0`,
		&	$casToken = `null`
	)

abstractprotected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	Token to use for check-and-set comparisons

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

Referenced by cas(), changeTTL(), delete(), doGetMulti(), get(), mergeViaCas(), and trackDuplicateKeys().

◆ doGetMulti()

BagOStuff::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

Definition at line 685 of file BagOStuff.php.

References $res, as, and doGet().

Referenced by getMulti(), and resolveSegments().

◆ doSet()

BagOStuff::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

Referenced by changeTTL(), set(), and setMulti().

◆ expiryIsRelative()

BagOStuff::expiryIsRelative ( $exptime )

protected

Parameters

int $exptime

Returns: bool

Definition at line 887 of file BagOStuff.php.

Referenced by RedisBagOStuff\changeTTL(), and convertToExpiry().

◆ get()

BagOStuff::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

Definition at line 203 of file BagOStuff.php.

References doGet(), resolveSegments(), and trackDuplicateKeys().

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown(), and BagOStuffTest\testReportDupes().

◆ getCurrentTime()

BagOStuff::getCurrentTime ( )

Definition at line 1032 of file BagOStuff.php.

Referenced by changeTTL(), convertToExpiry(), convertToRelative(), HashBagOStuff\expire(), and getScopedLock().

◆ getLastError()

BagOStuff::getLastError ( )

Get the "last error" registered; clearLastError() should be called manually.

Returns: int ERR_* constant for the "last error" registry

Since: 1.23

Definition at line 827 of file BagOStuff.php.

References $lastError.

Referenced by incrWithInit(), lock(), and mergeViaCas().

◆ getMulti()

BagOStuff::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
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array

Definition at line 669 of file BagOStuff.php.

References $value, as, doGetMulti(), and resolveSegments().

◆ getQoS()

BagOStuff::getQoS ( $flag )

Parameters

int $flag ATTR_* class constant

Returns: int QOS_* class constant

Since: 1.28

Definition at line 986 of file BagOStuff.php.

Referenced by MWLBFactory\injectObjectCaches(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ getScopedLock()

BagOStuff::getScopedLock	(	$key,
		$timeout = `6`,
		$expiry = `30`,
		$rclass = `''`
	)

final

Get a lightweight exclusive self-unlocking lock.

Note that the same lock cannot be acquired twice.

This is useful for task de-duplication or to avoid obtrusive (though non-corrupting) DB errors like INSERT key conflicts or deadlocks when using LOCK IN SHARE MODE.

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$expiry	Lock expiry [optional]; 1 day maximum
string	$rclass	Allow reentry if set and the current lock used this value

Returns: ScopedCallback|null Returns null on failure

Since: 1.26

Definition at line 626 of file BagOStuff.php.

References getCurrentTime(), lock(), null, unlock(), and use.

◆ getSegmentationSize()

BagOStuff::getSegmentationSize ( )

Returns: int|float The chunk size, in bytes, of segmented objects (INF for no limit)

Since: 1.34

Definition at line 994 of file BagOStuff.php.

References $segmentationSize.

Referenced by set().

◆ getSegmentedValueMaxSize()

BagOStuff::getSegmentedValueMaxSize ( )

Returns: int|float Maximum total segmented object size in bytes (INF for no limit)

Since: 1.34

Definition at line 1002 of file BagOStuff.php.

References $segmentedValueMaxSize.

Referenced by set().

◆ getWithSetCallback()

BagOStuff::getWithSetCallback	(	$key,
		$ttl,
		$callback,
		$flags = `0`
	)

final

Get an item with the given key, regenerating and setting it if not found.

Nothing is stored nor deleted if the callback returns false

Parameters

string	$key
int	$ttl	Time-to-live (seconds)
callable	$callback	Callback that derives the new value
int	$flags	Bitfield of BagOStuff::READ_* or BagOStuff::WRITE_* constants [optional]

Returns: mixed The cached value if found or the result of $callback otherwise

Since: 1.27

Definition at line 174 of file BagOStuff.php.

References $value.

◆ incr()

BagOStuff::incr	(	$key,
		$value = `1`
	)

abstract

Increase stored value of $key by $value while preserving its TTL.

Parameters

string	$key	Key to increase
int	$value	Value to add to $key (default: 1) [optional]

Returns: int|bool New value or false on failure

Referenced by decr(), deleteMulti(), and incrWithInit().

◆ incrWithInit()

BagOStuff::incrWithInit	(	$key,
		$ttl,
		$value = `1`,
		$init = `1`
	)

Increase stored value of $key by $value while preserving its TTL.

This will create the key with value $init and TTL $ttl instead if not present

Parameters

string	$key
int	$ttl
int	$value
int	$init

Returns: int|bool New value or false on failure

Since: 1.24

Definition at line 770 of file BagOStuff.php.

References $value, add(), clearLastError(), getLastError(), and incr().

◆ isInteger()

BagOStuff::isInteger ( $value )

protected

Check if a value is an integer.

Parameters

mixed $value

Returns: bool

Definition at line 929 of file BagOStuff.php.

References $value.

Referenced by HashBagOStuff\incr(), WinCacheBagOStuff\incr(), RESTBagOStuff\incr(), MemcachedPhpBagOStuff\unserialize(), MemcachedPeclBagOStuff\unserialize(), and unserialize().

◆ lock()

BagOStuff::lock	(	$key,
		$timeout = `6`,
		$expiry = `6`,
		$rclass = `''`
	)

Acquire an advisory lock on a key string.

Note that if reentry is enabled, duplicate calls ignore $expiry

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$expiry	Lock expiry [optional]; 1 day maximum
string	$rclass	Allow reentry if set and the current lock used this value

Returns: bool Success

Definition at line 540 of file BagOStuff.php.

References $code, $fname, add(), clearLastError(), getLastError(), and use.

Referenced by cas(), changeTTL(), getScopedLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ makeGlobalKey()

BagOStuff::makeGlobalKey	(	$class,
		$component = `null`
	)

Make a global cache key.

Since: 1.27

Parameters

string	$class	Key class
string \| null	$component	[optional] Key component (starting with a key collection name)

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Definition at line 965 of file BagOStuff.php.

References makeKeyInternal().

Referenced by Wikimedia\Rdbms\ChronologyProtector\__construct(), delete(), Wikimedia\Rdbms\ChronologyProtector\getTouchedKey(), resolveSegments(), set(), and BagOStuffTest\testMakeKey().

◆ makeKey()

BagOStuff::makeKey	(	$class,
		$component = `null`
	)

Make a cache key, scoped to this instance's keyspace.

Since: 1.27

Parameters

string	$class	Key class
string \| null	$component	[optional] Key component (starting with a key collection name)

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Definition at line 977 of file BagOStuff.php.

References makeKeyInternal().

Referenced by CryptHKDF\__construct(), FileCacheBase\cacheMissKey(), SiteStatsUpdate\getTypeCacheKey(), and BagOStuffTest\testMakeKey().

◆ makeKeyInternal()

BagOStuff::makeKeyInternal	(	$keyspace,
		$args
	)

Construct a cache key.

Since: 1.27

Parameters

string	$keyspace
array	$args

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Definition at line 949 of file BagOStuff.php.

References $args, $keyspace, and as.

Referenced by makeGlobalKey(), makeKey(), and BagOStuffTest\testMakeKey().

◆ merge()

BagOStuff::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 overriden 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

Exceptions

InvalidArgumentException

Definition at line 394 of file BagOStuff.php.

References mergeViaCas().

◆ mergeFlagMaps()

BagOStuff::mergeFlagMaps ( array $bags )

protected

Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

Parameters

BagOStuff[] $bags

Returns: int[] Resulting flag map (class ATTR_* constant => class QOS_* constant)

Definition at line 1012 of file BagOStuff.php.

References as.

Referenced by ReplicatedBagOStuff\__construct(), and MultiWriteBagOStuff\__construct().

◆ mergeViaCas()

BagOStuff::mergeViaCas	(	$key,
		$callback,
		$exptime = `0`,
		$attempts = `10`,
		$flags = `0`
	)

protected

See also: BagOStuff::merge()

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

Definition at line 408 of file BagOStuff.php.

References $success, $value, add(), cas(), clearLastError(), doGet(), false, getLastError(), null, and resolveSegments().

Referenced by merge(), and SqlBagOStuff\merge().

◆ resolveSegments()

BagOStuff::resolveSegments	(	$key,
		$mainValue
	)

protected

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 792 of file BagOStuff.php.

References as, doGetMulti(), SerializedValueContainer\isSegmented(), SerializedValueContainer\isUnified(), makeGlobalKey(), SerializedValueContainer\SEGMENTED_HASHES, SerializedValueContainer\UNIFIED_DATA, unserialize(), and use.

Referenced by get(), getMulti(), and mergeViaCas().

◆ serialize()

BagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int String/integer representation

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

Definition at line 1050 of file BagOStuff.php.

References $value.

Referenced by APCUBagOStuff\add(), APCBagOStuff\add(), WinCacheBagOStuff\add(), RedisBagOStuff\add(), APCBagOStuff\doSet(), APCUBagOStuff\doSet(), WinCacheBagOStuff\doSet(), RedisBagOStuff\doSet(), set(), and RedisBagOStuff\setMulti().

◆ set()

BagOStuff::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

Returns: bool Success

Definition at line 259 of file BagOStuff.php.

References $serialized, doSet(), getSegmentationSize(), getSegmentedValueMaxSize(), makeGlobalKey(), SerializedValueContainer\newSegmented(), SerializedValueContainer\newUnified(), serialize(), setLastError(), and setMulti().

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown(), and BagOStuffTest\testMerge().

◆ setDebug()

BagOStuff::setDebug ( $bool )

Parameters

bool $bool

Definition at line 158 of file BagOStuff.php.

◆ setLastError()

BagOStuff::setLastError ( $err )

protected

Set the "last error" registry.

Parameters

int $err ERR_* constant

Since: 1.23

Definition at line 844 of file BagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\getConnection(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), set(), and SqlBagOStuff\setAndLogDBError().

◆ setLogger()

BagOStuff::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Returns: void

Definition at line 151 of file BagOStuff.php.

References $logger.

Referenced by __construct().

◆ setMockTime()

BagOStuff::setMockTime ( & $time )

Definition at line 1041 of file BagOStuff.php.

References $time.

Referenced by MediaWiki\Tests\Storage\NameTableStoreTest\testGetName().

◆ setMulti()

BagOStuff::setMulti	(	array	$data,
			$exptime = `0`,
			$flags = `0`
	)

Batch insertion/replace.

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

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 (since 1.33)

Returns: bool Success

Since: 1.24

Definition at line 708 of file BagOStuff.php.

References $res, $value, as, and doSet().

Referenced by set().

◆ trackDuplicateKeys()

BagOStuff::trackDuplicateKeys ( $key )

private

Track the number of times that a given key has been used.

Parameters

string $key

Definition at line 213 of file BagOStuff.php.

References as, doGet(), and null.

Referenced by get().

◆ unlock()

BagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Definition at line 592 of file BagOStuff.php.

References doDelete().

Referenced by cas(), changeTTL(), getScopedLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ unserialize()

BagOStuff::unserialize ( $value )

protected

Parameters

string | int $value

Returns: mixed Original value or false on error

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

Definition at line 1059 of file BagOStuff.php.

References $value, and isInteger().

Referenced by WinCacheBagOStuff\doGet(), APCUBagOStuff\doGet(), APCBagOStuff\doGet(), RedisBagOStuff\doGet(), RedisBagOStuff\doGetMulti(), and resolveSegments().

Member Data Documentation

◆ $asyncHandler

callable null BagOStuff::$asyncHandler

protected

Definition at line 74 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\doWrite().

◆ $attrMap

int [] BagOStuff::$attrMap = []

protected

Map of (ATTR_* class constant => QOS_* class constant)

Definition at line 98 of file BagOStuff.php.

◆ $busyCallbacks

callable [] BagOStuff::$busyCallbacks = []

protected

Definition at line 92 of file BagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

◆ $debugMode

bool BagOStuff::$debugMode = false

private

Definition at line 83 of file BagOStuff.php.

◆ $dupeTrackScheduled

bool BagOStuff::$dupeTrackScheduled = false

private

Definition at line 89 of file BagOStuff.php.

◆ $duplicateKeyLookups

array BagOStuff::$duplicateKeyLookups = []

private

Definition at line 85 of file BagOStuff.php.

◆ $keyspace

string BagOStuff::$keyspace = 'local'

protected

Definition at line 70 of file BagOStuff.php.

Referenced by MemcachedBagOStuff\makeKeyInternal(), WinCacheBagOStuff\makeKeyInternal(), and makeKeyInternal().

◆ $lastError

int BagOStuff::$lastError = self::ERR_NONE

protected

ERR_* class constant.

Definition at line 68 of file BagOStuff.php.

Referenced by getLastError().

◆ $locks

array [] BagOStuff::$locks = []

protected

Lock tracking.

Definition at line 66 of file BagOStuff.php.

◆ $logger

LoggerInterface BagOStuff::$logger

protected

Definition at line 72 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\doWrite(), and setLogger().

◆ $reportDupes

bool BagOStuff::$reportDupes = false

private

Definition at line 87 of file BagOStuff.php.

◆ $segmentationSize

int BagOStuff::$segmentationSize

protected

Bytes; chunk size of segmented cache values.

Definition at line 78 of file BagOStuff.php.

Referenced by getSegmentationSize().

◆ $segmentedValueMaxSize

int BagOStuff::$segmentedValueMaxSize

protected

Bytes; maximum total size of a segmented cache value.

Definition at line 80 of file BagOStuff.php.

Referenced by getSegmentedValueMaxSize().

◆ $syncTimeout

int BagOStuff::$syncTimeout

protected

Seconds.

Definition at line 76 of file BagOStuff.php.

◆ $wallClockOverride

float null BagOStuff::$wallClockOverride

private

Definition at line 95 of file BagOStuff.php.

◆ READ_LATEST

const BagOStuff::READ_LATEST = 1

Bitfield constants for get()/getMulti()

Definition at line 101 of file BagOStuff.php.

Referenced by SiteStatsUpdate\getPendingDeltas(), and BagOStuffTest\testSetDeleteMulti().

◆ READ_VERIFIED

const BagOStuff::READ_VERIFIED = 2

Definition at line 102 of file BagOStuff.php.

Referenced by ParserCache\get(), and ParserCache\getKey().

◆ WRITE_ALLOW_SEGMENTS

const BagOStuff::WRITE_ALLOW_SEGMENTS = 16

Definition at line 106 of file BagOStuff.php.

Referenced by MediaWiki\Storage\PageEditStash\stashInputText(), MediaWiki\Storage\PageEditStash\storeStashValue(), and BagOStuffTest\testSetSegmentable().

◆ WRITE_CACHE_ONLY

const BagOStuff::WRITE_CACHE_ONLY = 8

Definition at line 105 of file BagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\save(), and CachedBagOStuffTest\testWriteCacheOnly().

◆ WRITE_PRUNE_SEGMENTS

const BagOStuff::WRITE_PRUNE_SEGMENTS = 32

Definition at line 107 of file BagOStuff.php.

Referenced by MediaWiki\Storage\PageEditStash\pruneExcessStashedEntries(), and BagOStuffTest\testSetSegmentable().

◆ WRITE_SYNC

const BagOStuff::WRITE_SYNC = 4

Bitfield constants for set()/merge()

Definition at line 104 of file BagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\save(), and MultiWriteBagOStuffTest\testSyncMerge().

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

includes/libs/objectcache/BagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addBusyCallback()

◆ cas()

◆ changeTTL()

◆ clearLastError()

◆ convertToExpiry()

◆ convertToRelative()

◆ debug()

◆ decr()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ doDelete()

◆ doGet()

◆ doGetMulti()

◆ doSet()

◆ expiryIsRelative()

◆ get()

◆ getCurrentTime()

◆ getLastError()

◆ getMulti()

◆ getQoS()

◆ getScopedLock()

◆ getSegmentationSize()

◆ getSegmentedValueMaxSize()

◆ getWithSetCallback()

◆ incr()

◆ incrWithInit()

◆ isInteger()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ merge()

◆ mergeFlagMaps()

◆ mergeViaCas()

◆ resolveSegments()

◆ serialize()

◆ set()

◆ setDebug()

◆ setLastError()

◆ setLogger()

◆ setMockTime()

◆ setMulti()

◆ trackDuplicateKeys()

◆ unlock()

◆ unserialize()

Member Data Documentation

◆ $asyncHandler

◆ $attrMap

◆ $busyCallbacks

◆ $debugMode

◆ $dupeTrackScheduled

◆ $duplicateKeyLookups

◆ $keyspace

◆ $lastError

◆ $locks

◆ $logger

◆ $reportDupes

◆ $segmentationSize

◆ $segmentedValueMaxSize

◆ $syncTimeout

◆ $wallClockOverride

◆ READ_LATEST

◆ READ_VERIFIED

◆ WRITE_ALLOW_SEGMENTS

◆ WRITE_CACHE_ONLY

◆ WRITE_PRUNE_SEGMENTS

◆ WRITE_SYNC