A cache class that replicates all writes to multiple child caches. More...

Inheritance diagram for MultiWriteBagOStuff:

[legend]

Collaboration diagram for MultiWriteBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	$params include:

	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.

	clearLastError ()
	Clear the "last error" registry.

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

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

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

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete 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)
	Increase stored value of $key by $value while preserving its TTL.

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

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

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

	makeKey ( $class, $component=null)
	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 ( $debug)

	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=[])
	$params include:

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

	getQoS ( $flag)

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

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

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

Public Attributes
const	UPGRADE_TTL = 3600

Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

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

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
	doGet ( $key, $flags=0, &$casToken=null)

	doWrite ( $indexes, $asyncWrites, $method, array $args)
	Apply a write method to the backing caches specified by $indexes (in order)

	usesAsyncWritesGivenFlags ( $flags)

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

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

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

	debug ( $text)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

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

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

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

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

Protected Attributes
bool	$asyncWrites = false
	Use async secondary writes.

int[]	$cacheIndexes = []
	List of all backing cache indexes.

BagOStuff[]	$caches

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

int	$syncTimeout
	Seconds.

Detailed Description

A cache class that replicates all writes to multiple child caches.

Reads are implemented by reading from the caches in the order they are given in the configuration until a cache gives a positive result.

Note that cache key construction will use the first cache backend in the list, so make sure that the other backends can handle such keys (e.g. via encoding).

Definition at line 35 of file MultiWriteBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MultiWriteBagOStuff::__construct ( $params )

$params include:

caches: A numbered array of either ObjectFactory::getObjectFromSpec arrays yeilding BagOStuff objects or direct BagOStuff objects. If using the former, the 'args' field must be set. The first cache is the primary one, being the first to be read in the fallback chain. Writes happen to all stores in the order they are defined. However, lock()/unlock() calls only use the primary store.
replication: Either 'sync' or 'async'. This controls whether writes to secondary stores are deferred when possible. Async writes require setting 'asyncHandler'. HHVM register_postsend_function() function. Async writes can increase the chance of some race conditions or cause keys to expire seconds later than expected. It is safe to use for modules when cached values: are immutable, invalidation uses logical TTLs, invalidation uses etag/timestamp validation against the DB, or merge() is used to handle races.
Parameters

array $params

Exceptions

InvalidArgumentException

Definition at line 65 of file MultiWriteBagOStuff.php.

References $params, and(), and BagOStuff\mergeFlagMaps().

Member Function Documentation

◆ add()

MultiWriteBagOStuff::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 157 of file MultiWriteBagOStuff.php.

References $value, and(), doWrite(), and usesAsyncWritesGivenFlags().

Referenced by MultiWriteBagOStuffTest\testDuplicateStoreAdd().

◆ changeTTL()

MultiWriteBagOStuff::changeTTL	(	$key,
		$expiry = 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

Parameters

string	$key
int	$expiry	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 190 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ clearLastError()

MultiWriteBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 289 of file MultiWriteBagOStuff.php.

◆ decr()

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

Reimplemented from BagOStuff.

Definition at line 267 of file MultiWriteBagOStuff.php.

References and(), and doWrite().

◆ delete()

MultiWriteBagOStuff::delete	(		$key,
			$flags = 0 )

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

Reimplemented from BagOStuff.

Definition at line 148 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ deleteMulti()

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

Batch deletion.

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 249 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ deleteObjectsExpiringBefore()

MultiWriteBagOStuff::deleteObjectsExpiringBefore	(		$date,
			$progressCallback = false )

Delete objects expiring before a certain date.

Succeed if any of the child caches succeed.

Parameters

string	$date
bool \| callable	$progressCallback

Returns: bool

Reimplemented from BagOStuff.

Definition at line 216 of file MultiWriteBagOStuff.php.

References $cache, and $ret.

◆ doGet()

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

protected

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

Reimplemented from BagOStuff.

Definition at line 353 of file MultiWriteBagOStuff.php.

◆ doWrite()

MultiWriteBagOStuff::doWrite	(		$indexes,
			$asyncWrites,
			$method,
		array	$args )

protected

Apply a write method to the backing caches specified by $indexes (in order)

Parameters

int[]	$indexes	List of backing cache indexes
bool	$asyncWrites
string	$method	Method name of backing caches
array[]	$args	Arguments to the method of backing caches

Returns: bool

Definition at line 301 of file MultiWriteBagOStuff.php.

References $args, BagOStuff\$asyncHandler, $asyncWrites, $cache, BagOStuff\$logger, $ret, and(), serialize(), unserialize(), and use.

Referenced by add(), changeTTL(), decr(), delete(), deleteMulti(), get(), incr(), incrWithInit(), merge(), set(), and setMulti().

◆ get()

MultiWriteBagOStuff::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 106 of file MultiWriteBagOStuff.php.

References $cache, $value, and(), doWrite(), BagOStuff\READ_LATEST, and BagOStuff\READ_VERIFIED.

◆ getLastError()

MultiWriteBagOStuff::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 285 of file MultiWriteBagOStuff.php.

◆ getMulti()

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

Reimplemented from BagOStuff.

Definition at line 227 of file MultiWriteBagOStuff.php.

References $keys, $res, and and().

◆ incr()

MultiWriteBagOStuff::incr	(		$key,
			$value = 1 )

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

Reimplemented from BagOStuff.

Definition at line 258 of file MultiWriteBagOStuff.php.

References and(), and doWrite().

◆ incrWithInit()

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

Reimplemented from BagOStuff.

Definition at line 276 of file MultiWriteBagOStuff.php.

References and(), and doWrite().

◆ lock()

MultiWriteBagOStuff::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 199 of file MultiWriteBagOStuff.php.

◆ makeGlobalKey()

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

Reimplemented from BagOStuff.

Definition at line 349 of file MultiWriteBagOStuff.php.

References and().

Referenced by MultiWriteBagOStuffTest\testMakeGlobalKey().

◆ makeKey()

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

Reimplemented from BagOStuff.

Definition at line 345 of file MultiWriteBagOStuff.php.

References and().

Referenced by MultiWriteBagOStuffTest\testMakeKey().

◆ makeKeyInternal()

MultiWriteBagOStuff::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 341 of file MultiWriteBagOStuff.php.

References and().

◆ merge()

MultiWriteBagOStuff::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 181 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ set()

MultiWriteBagOStuff::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 139 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ setDebug()

MultiWriteBagOStuff::setDebug ( $bool )

Parameters

bool $bool

Reimplemented from BagOStuff.

Definition at line 100 of file MultiWriteBagOStuff.php.

References $cache, and $debug.

◆ setMulti()

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

Batch insertion/replace.

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 240 of file MultiWriteBagOStuff.php.

References and(), doWrite(), and usesAsyncWritesGivenFlags().

◆ unlock()

MultiWriteBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 204 of file MultiWriteBagOStuff.php.

◆ usesAsyncWritesGivenFlags()

MultiWriteBagOStuff::usesAsyncWritesGivenFlags ( $flags )

protected

Parameters

int $flags

Returns: bool

Definition at line 337 of file MultiWriteBagOStuff.php.

References $asyncWrites, and false.

Referenced by add(), changeTTL(), delete(), deleteMulti(), merge(), set(), and setMulti().

Member Data Documentation

◆ $asyncWrites

bool MultiWriteBagOStuff::$asyncWrites = false

protected

Use async secondary writes.

Definition at line 39 of file MultiWriteBagOStuff.php.

Referenced by doWrite(), and usesAsyncWritesGivenFlags().

◆ $cacheIndexes

int [] MultiWriteBagOStuff::$cacheIndexes = []

protected

List of all backing cache indexes.

Definition at line 41 of file MultiWriteBagOStuff.php.

◆ $caches

BagOStuff [] MultiWriteBagOStuff::$caches

protected

Definition at line 37 of file MultiWriteBagOStuff.php.

◆ UPGRADE_TTL

const MultiWriteBagOStuff::UPGRADE_TTL = 3600

Definition at line 43 of file MultiWriteBagOStuff.php.

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

includes/libs/objectcache/MultiWriteBagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ changeTTL()

◆ clearLastError()

◆ decr()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ doGet()

◆ doWrite()

◆ get()

◆ getLastError()

◆ getMulti()

◆ incr()

◆ incrWithInit()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ merge()

◆ set()

◆ setDebug()

◆ setMulti()

◆ unlock()

◆ usesAsyncWritesGivenFlags()

Member Data Documentation

◆ $asyncWrites

◆ $cacheIndexes

◆ $caches

◆ UPGRADE_TTL