A cache class that directs writes to one set of servers and reads to another. More...

Inheritance diagram for ReplicatedBagOStuff:

[legend]

Collaboration diagram for ReplicatedBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	Constructor. More...

	add ( $key, $value, $exptime=0)

	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)
	Delete an item. More...

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

	incr ( $key, $value=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...

	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 ( $debug)

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

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

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

	changeTTL ( $key, $expiry=0)
	Reset the TTL on a key if it exists. More...

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

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

	getQoS ( $flag)

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

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

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

	makeGlobalKey ()
	Make a global cache key. More...

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

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

	modifySimpleRelayEvent (array $event)
	Modify a cache update operation array for EventRelayer::notify() More...

	setLogger (LoggerInterface $logger)

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

Protected Member Functions
	doGet ( $key, $flags=0)

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

	convertExpiry ( $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)

	getWithToken ( $key, &$casToken, $flags=0)

	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)

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

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

Protected Attributes
BagOStuff	$readStore

BagOStuff	$writeStore

Protected Attributes inherited from BagOStuff
callback 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	$syncTimeout
	Seconds. More...

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0
	Possible values for getLastError() More...

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

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

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

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

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 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_WEEK = 604800

const	TTL_YEAR = 31536000

Detailed Description

A cache class that directs writes to one set of servers and reads to another.

This assumes that the servers used for reads are setup to replica DB those that writes go to. This can easily be used with redis for example.

In the WAN scenario (e.g. multi-datacenter case), this is useful when writes are rare or they usually take place in the primary datacenter.

Since: 1.26

Definition at line 33 of file ReplicatedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

ReplicatedBagOStuff::__construct ( $params )

Constructor.

Parameters are:

writeFactory : ObjectFactory::getObjectFromSpec array yeilding BagOStuff. This object will be used for writes (e.g. the master DB).
readFactory : ObjectFactory::getObjectFromSpec array yeilding BagOStuff. This object will be used for reads (e.g. a replica DB).

Parameters

array $params

Exceptions

InvalidArgumentException

Definition at line 49 of file ReplicatedBagOStuff.php.

References $params, false, ObjectFactory\getObjectFromSpec(), and BagOStuff\mergeFlagMaps().

Member Function Documentation

◆ add()

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

Parameters

string	$key
mixed	$value
int	$exptime

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 96 of file ReplicatedBagOStuff.php.

References $value.

◆ clearLastError()

ReplicatedBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 126 of file ReplicatedBagOStuff.php.

◆ decr()

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

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

Parameters

string	$key
int	$value

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 104 of file ReplicatedBagOStuff.php.

References $value.

◆ delete()

ReplicatedBagOStuff::delete ( $key )

Delete an item.

Parameters

string $key

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

Reimplemented from BagOStuff.

Definition at line 92 of file ReplicatedBagOStuff.php.

◆ doGet()

ReplicatedBagOStuff::doGet	(	$key,
		$flags = `0`
	)

protected

Parameters

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

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

Reimplemented from BagOStuff.

Definition at line 76 of file ReplicatedBagOStuff.php.

References $flags.

◆ getLastError()

ReplicatedBagOStuff::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 120 of file ReplicatedBagOStuff.php.

References BagOStuff\ERR_NONE.

◆ getMulti()

ReplicatedBagOStuff::getMulti	(	array	$keys,
			$flags = `0`
	)

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

Parameters

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

Returns: array

Reimplemented from BagOStuff.

Definition at line 82 of file ReplicatedBagOStuff.php.

References $flags, and $keys.

◆ incr()

ReplicatedBagOStuff::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)

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 100 of file ReplicatedBagOStuff.php.

References $value.

◆ lock()

ReplicatedBagOStuff::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 108 of file ReplicatedBagOStuff.php.

◆ merge()

ReplicatedBagOStuff::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.

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 116 of file ReplicatedBagOStuff.php.

References $flags.

◆ set()

ReplicatedBagOStuff::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 ReplicatedBagOStuff.php.

References $flags, and $value.

◆ setDebug()

ReplicatedBagOStuff::setDebug ( $bool )

Parameters

bool $bool

Reimplemented from BagOStuff.

Definition at line 71 of file ReplicatedBagOStuff.php.

References $debug.

◆ unlock()

ReplicatedBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 112 of file ReplicatedBagOStuff.php.

Member Data Documentation

◆ $readStore

BagOStuff ReplicatedBagOStuff::$readStore

protected

Definition at line 37 of file ReplicatedBagOStuff.php.

◆ $writeStore

BagOStuff ReplicatedBagOStuff::$writeStore

protected

Definition at line 35 of file ReplicatedBagOStuff.php.

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

includes/libs/objectcache/ReplicatedBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ clearLastError()

◆ decr()

◆ delete()

◆ doGet()

◆ getLastError()

◆ getMulti()

◆ incr()

◆ lock()

◆ merge()

◆ set()

◆ setDebug()

◆ unlock()

Member Data Documentation

◆ $readStore

◆ $writeStore