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

Inheritance diagram for ReplicatedBagOStuff:

Collaboration diagram for ReplicatedBagOStuff:

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

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

	clearLastError ()

	decr ($key, $value=1)

	delete ($key)

	getLastError ()

	getMulti (array $keys, $flags=0)

	incr ($key, $value=1)

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

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

	set ($key, $value, $exptime=0, $flags=0)

	setDebug ($debug)

	unlock ($key)

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	$params include: 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...

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

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

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

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

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

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

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

	setDebug ($bool)

	setLogger (LoggerInterface $logger)

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

	unlock ($key)
	Release an advisory lock on a key string. 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)

	doGet ($key, $flags=0)

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

	isInteger ($value)
	Check if a value is an integer. 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

string	$keyspace = 'local'

integer	$lastError = self::ERR_NONE

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

LoggerInterface	$logger

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

Constructor & Destructor Documentation

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 slave DB).

Parameters

array $params

Exceptions

InvalidArgumentException

Definition at line 50 of file ReplicatedBagOStuff.php.

References $params, and ObjectFactory\getObjectFromSpec().

Member Function Documentation

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

Definition at line 95 of file ReplicatedBagOStuff.php.

References $value.

ReplicatedBagOStuff::clearLastError ( )

Definition at line 125 of file ReplicatedBagOStuff.php.

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

Definition at line 103 of file ReplicatedBagOStuff.php.

References $value.

ReplicatedBagOStuff::delete ( $key )

Definition at line 91 of file ReplicatedBagOStuff.php.

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

protected

Definition at line 75 of file ReplicatedBagOStuff.php.

References $flags.

ReplicatedBagOStuff::getLastError ( )

Definition at line 119 of file ReplicatedBagOStuff.php.

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

Definition at line 81 of file ReplicatedBagOStuff.php.

References $flags.

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

Definition at line 99 of file ReplicatedBagOStuff.php.

References $value.

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

Definition at line 107 of file ReplicatedBagOStuff.php.

ReplicatedBagOStuff::merge	(		$key,
		callable	$callback,
			$exptime = `0`,
			$attempts = `10`,
			$flags = `0`
	)

Definition at line 115 of file ReplicatedBagOStuff.php.

References $flags.

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

Definition at line 87 of file ReplicatedBagOStuff.php.

References $flags, and $value.

ReplicatedBagOStuff::setDebug ( $debug )

Definition at line 70 of file ReplicatedBagOStuff.php.

References $debug.

ReplicatedBagOStuff::unlock ( $key )

Definition at line 111 of file ReplicatedBagOStuff.php.

Member Data Documentation

BagOStuff ReplicatedBagOStuff::$readStore

protected

Definition at line 38 of file ReplicatedBagOStuff.php.

BagOStuff ReplicatedBagOStuff::$writeStore

protected

Definition at line 36 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

Member Function Documentation

Member Data Documentation