Wrapper around a BagOStuff that caches data in memory. More...

Inheritance diagram for CachedBagOStuff:

[legend]

Collaboration diagram for CachedBagOStuff:

[legend]

Public Member Functions
	__construct (BagOStuff $backend, $params=[])

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

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

	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.

	clearLastError ()
	Clear the "last error" registry.

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

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

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

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

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

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

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

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

	incrWithInit ( $key, $exptime, $value=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, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string.

	makeGlobalKey ( $class,... $components)
	Make a global cache key.

	makeKey ( $class,... $components)
	Make a cache key, scoped to this instance's keyspace.

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

	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.

	setDebug ( $enabled)

	setMockTime (&$time)

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

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

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	Parameters include:

	getCurrentTime ()

	getQoS ( $flag)

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

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

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

	setLogger (LoggerInterface $logger)

Protected Attributes
BagOStuff	$backend

HashBagOStuff	$procCache

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

bool	$debugMode = false

LoggerInterface	$logger

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.

const	READ_VERIFIED = 2

const	WRITE_ALLOW_SEGMENTS = 16

const	WRITE_BACKGROUND = 64

const	WRITE_CACHE_ONLY = 8

const	WRITE_PRUNE_SEGMENTS = 32

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

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 inherited from BagOStuff
	fieldHasFlags ( $field, $flags)

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

Detailed Description

Wrapper around a BagOStuff that caches data in memory.

The differences between CachedBagOStuff and MultiWriteBagOStuff are:

CachedBagOStuff supports only one "backend".
There's a flag for writes to only go to the in-memory cache.
The in-memory cache is always updated.
Locks go to the backend cache (with MultiWriteBagOStuff, it would wind up going to the HashBagOStuff used for the in-memory cache).

Definition at line 36 of file CachedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

CachedBagOStuff::__construct	(	BagOStuff	$backend,
			$params = [] )

Parameters

BagOStuff	$backend	Permanent backend to use
array	$params	Parameters for HashBagOStuff

Definition at line 46 of file CachedBagOStuff.php.

Member Function Documentation

◆ add()

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

Reimplemented from BagOStuff.

Definition at line 108 of file CachedBagOStuff.php.

◆ addBusyCallback()

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

Reimplemented from BagOStuff.

Definition at line 217 of file CachedBagOStuff.php.

◆ changeTTL()

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

Definition at line 125 of file CachedBagOStuff.php.

◆ changeTTLMulti()

CachedBagOStuff::changeTTLMulti	(	array	$keys,
			$exptime,
			$flags = 0 )

Change the expiration of multiple keys that exist.

See also: BagOStuff::changeTTL()

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

Definition at line 189 of file CachedBagOStuff.php.

References $keys, and BagOStuff\fieldHasFlags().

◆ clearLastError()

CachedBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 165 of file CachedBagOStuff.php.

◆ decr()

CachedBagOStuff::decr	(	$key,
		$value = 1,
		$flags = 0 )

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

Parameters

string	$key
int	$value	Value to subtract from $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 205 of file CachedBagOStuff.php.

◆ delete()

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

Reimplemented from BagOStuff.

Definition at line 98 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

◆ deleteMulti()

CachedBagOStuff::deleteMulti	(	array	$keys,
			$flags = 0 )

Batch deletion.

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

Since: 1.33

Reimplemented from BagOStuff.

Definition at line 179 of file CachedBagOStuff.php.

References $keys, and BagOStuff\fieldHasFlags().

◆ deleteObjectsExpiringBefore()

CachedBagOStuff::deleteObjectsExpiringBefore	(		$timestamp,
		callable	$progress = null,
			$limit = INF )

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	$limit	Maximum number of keys to delete [default: INF]

Returns: bool Success; false if unimplemented

Reimplemented from BagOStuff.

Definition at line 139 of file CachedBagOStuff.php.

◆ get()

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

Definition at line 59 of file CachedBagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ getLastError()

CachedBagOStuff::getLastError ( )

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

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

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 161 of file CachedBagOStuff.php.

◆ getMulti()

CachedBagOStuff::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: mixed[] Map of (key => value) for existing keys

Reimplemented from BagOStuff.

Definition at line 69 of file CachedBagOStuff.php.

References $keys, and setMulti().

◆ incr()

CachedBagOStuff::incr	(	$key,
		$value = 1,
		$flags = 0 )

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]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 199 of file CachedBagOStuff.php.

◆ incrWithInit()

CachedBagOStuff::incrWithInit	(	$key,
		$exptime,
		$value = 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 $ttl instead if not present. Callers should make sure that both ($init - $value) and $ttl are invariants for all operations to any given key. The value of $init should be at least that of $value.

Parameters

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

Returns: int|bool New value or false on failure

Since: 1.24

Reimplemented from BagOStuff.

Definition at line 211 of file CachedBagOStuff.php.

◆ lock()

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

Reimplemented from BagOStuff.

Definition at line 131 of file CachedBagOStuff.php.

◆ makeGlobalKey()

CachedBagOStuff::makeGlobalKey	(		$class,
			$components )

Make a global cache key.

Since: 1.27

Parameters

string	$class	Key class
	string	...$components Key components (starting with a key collection name)

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

Reimplemented from BagOStuff.

Definition at line 157 of file CachedBagOStuff.php.

◆ makeKey()

CachedBagOStuff::makeKey	(		$class,
			$components )

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

Since: 1.27

Parameters

string	$class	Key class
	string	...$components Key components (starting with a key collection name)

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

Reimplemented from BagOStuff.

Definition at line 153 of file CachedBagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ makeKeyInternal()

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

Reimplemented from BagOStuff.

Definition at line 149 of file CachedBagOStuff.php.

References $args.

◆ merge()

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

Reimplemented from BagOStuff.

Definition at line 119 of file CachedBagOStuff.php.

◆ set()

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

Reimplemented from BagOStuff.

Definition at line 88 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

◆ setDebug()

CachedBagOStuff::setDebug ( $enabled )

Parameters

bool $enabled

Reimplemented from BagOStuff.

Definition at line 54 of file CachedBagOStuff.php.

◆ setMockTime()

CachedBagOStuff::setMockTime ( & $time )

Reimplemented from BagOStuff.

Definition at line 221 of file CachedBagOStuff.php.

◆ setMulti()

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

Batch insertion/replace.

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

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

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

Reimplemented from BagOStuff.

Definition at line 169 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

Referenced by getMulti().

◆ unlock()

CachedBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 135 of file CachedBagOStuff.php.

Member Data Documentation

◆ $backend

BagOStuff CachedBagOStuff::$backend

protected

Definition at line 38 of file CachedBagOStuff.php.

◆ $procCache

HashBagOStuff CachedBagOStuff::$procCache

protected

Definition at line 40 of file CachedBagOStuff.php.

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

includes/libs/objectcache/CachedBagOStuff.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addBusyCallback()

◆ changeTTL()

◆ changeTTLMulti()

◆ clearLastError()

◆ decr()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ get()

◆ getLastError()

◆ getMulti()

◆ incr()

◆ incrWithInit()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ merge()

◆ set()

◆ setDebug()

◆ setMockTime()

◆ setMulti()

◆ unlock()

Member Data Documentation

◆ $backend

◆ $procCache