Redis-based caching module for redis server >= 2.6.12 and phpredis >= 2.2.4. More...

Inheritance diagram for RedisBagOStuff:

[legend]

Collaboration diagram for RedisBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	Construct a RedisBagOStuff object.

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

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

	delete ( $key)
	Delete an item.

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

	incr ( $key, $value=1)
	Non-atomic implementation of incr().

	logRequest ( $method, $key, $server, $result)
	Send information about a single request to the debug log.

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

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

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

	setMulti (array $data, $expiry=0)

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.

	clearLastError ()
	Clear the "last error" registry.

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

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

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

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

	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.

	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.

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

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

	getConnection ( $key)
	Get a Redis object with a connection suitable for fetching the specified key.

	getMasterLinkStatus (RedisConnRef $conn)
	Check the master link status of a Redis server that is configured as a replica DB.

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

	handleException (RedisConnRef $conn, $e)
	The redis extension throws an exception in response to various read, write and protocol errors.

	logError ( $msg)
	Log a fatal error.

	serialize ( $data)

	unserialize ( $data)

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

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

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

	debug ( $text)

	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)

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

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

Protected Attributes
bool	$automaticFailover

RedisConnectionPool	$redisPool

array	$servers
	List of server names.

array	$serverTagMap
	Map of (tag => server name)

Protected Attributes inherited from BagOStuff
callback 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.

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

const	ERR_NONE = 0
	Possible values for getLastError()

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

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

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

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

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_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Detailed Description

Redis-based caching module for redis server >= 2.6.12 and phpredis >= 2.2.4.

See also: https://github.com/phpredis/phpredis/blob/d310ed7c8/Changelog.md

Note: Avoid use of Redis::MULTI transactions for twemproxy support

Definition at line 32 of file RedisBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

RedisBagOStuff::__construct ( $params )

Construct a RedisBagOStuff object.

Parameters are:

servers: An array of server names. A server name may be a hostname, a hostname/port combination or the absolute path of a UNIX socket. If a hostname is specified but no port, the standard port number 6379 will be used. Arrays keys can be used to specify the tag to hash on in place of the host/port. Required.
connectTimeout: The timeout for new connections, in seconds. Optional, default is 1 second.
persistent: Set this to true to allow connections to persist across multiple web requests. False by default.
password: The authentication password, will be sent to Redis in clear text. Optional, if it is unspecified, no AUTH command will be sent.
automaticFailover: If this is false, then each key will be mapped to a single server, and if that server is down, any requests for that key will fail. If this is true, a connection failure will cause the client to immediately try the next server in the list (as determined by a consistent hashing algorithm). True by default. This has the potential to create consistency issues if a server is slow enough to flap, for example if it is in swap death.
Parameters

array $params

Definition at line 70 of file RedisBagOStuff.php.

References $opt, $params, IExpiringStore\ATTR_SYNCWRITES, IExpiringStore\QOS_SYNCWRITES_NONE, servers, and RedisConnectionPool\singleton().

Member Function Documentation

◆ add()

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

Parameters

string	$key
mixed	$value
int	$exptime

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 246 of file RedisBagOStuff.php.

References $e, $result, BagOStuff\convertToRelative(), getConnection(), handleException(), list, logRequest(), and serialize().

◆ changeTTL()

RedisBagOStuff::changeTTL	(		$key,
			$expiry = 0 )

Reset the TTL on a key if it exists.

Parameters

string	$key
int	$expiry

Returns: bool Success Returns false if there is no key

Since: 1.28

Reimplemented from BagOStuff.

Definition at line 307 of file RedisBagOStuff.php.

References $e, $result, BagOStuff\convertToRelative(), getConnection(), handleException(), list, and logRequest().

◆ delete()

RedisBagOStuff::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 140 of file RedisBagOStuff.php.

References $e, $result, getConnection(), handleException(), list, and logRequest().

◆ doGet()

RedisBagOStuff::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 94 of file RedisBagOStuff.php.

References getWithToken().

◆ getConnection()

RedisBagOStuff::getConnection ( $key )

protected

Get a Redis object with a connection suitable for fetching the specified key.

Parameters

string $key

Returns: array (server, RedisConnRef) or (false, false)

Definition at line 357 of file RedisBagOStuff.php.

References $e, BagOStuff\ERR_UNREACHABLE, false, getMasterLinkStatus(), handleException(), servers, and BagOStuff\setLastError().

Referenced by add(), changeTTL(), delete(), getMulti(), getWithToken(), incr(), set(), and setMulti().

◆ getMasterLinkStatus()

RedisBagOStuff::getMasterLinkStatus ( RedisConnRef $conn )

protected

Check the master link status of a Redis server that is configured as a replica DB.

Parameters

RedisConnRef $conn

Returns: string|null Master link status (either 'up' or 'down'), or null if the server is not a replica DB.

Definition at line 409 of file RedisBagOStuff.php.

Referenced by getConnection().

◆ getMulti()

RedisBagOStuff::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 158 of file RedisBagOStuff.php.

References $e, $keys, $result, $value, BagOStuff\debug(), getConnection(), handleException(), list, and unserialize().

◆ getWithToken()

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

protected

Note: This method is only needed if merge() uses mergeViaCas()

Parameters

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

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

Exceptions

Exception

Reimplemented from BagOStuff.

Definition at line 100 of file RedisBagOStuff.php.

References $e, $result, $value, getConnection(), handleException(), list, logRequest(), and unserialize().

Referenced by doGet().

◆ handleException()

RedisBagOStuff::handleException	(	RedisConnRef	$conn,
			$e )

protected

The redis extension throws an exception in response to various read, write and protocol errors.

Sometimes it also closes the connection, sometimes not. The safest response for us is to explicitly destroy the connection object and let it be reopened during the next request.

Parameters

RedisConnRef	$conn
Exception	$e

Definition at line 430 of file RedisBagOStuff.php.

References $e, BagOStuff\ERR_UNEXPECTED, and BagOStuff\setLastError().

Referenced by add(), changeTTL(), delete(), getConnection(), getMulti(), getWithToken(), incr(), set(), and setMulti().

◆ incr()

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

Non-atomic implementation of incr().

Probably all callers actually want incr() to atomically initialise values to zero if they don't exist, as provided by the Redis INCR command. But we are constrained by the memcached-like interface to return null in that case. Once the key exists, further increments are atomic.

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 287 of file RedisBagOStuff.php.

References $e, $result, $value, getConnection(), handleException(), list, and logRequest().

◆ logError()

RedisBagOStuff::logError ( $msg )

protected

Log a fatal error.

Parameters

string $msg

Definition at line 418 of file RedisBagOStuff.php.

◆ logRequest()

RedisBagOStuff::logRequest	(	$method,
		$key,
		$server,
		$result )

Send information about a single request to the debug log.

Parameters

string	$method
string	$key
string	$server
bool	$result

Definition at line 442 of file RedisBagOStuff.php.

References BagOStuff\debug().

Referenced by add(), changeTTL(), delete(), getWithToken(), incr(), and set().

◆ merge()

RedisBagOStuff::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 271 of file RedisBagOStuff.php.

References BagOStuff\mergeViaCas().

◆ modifySimpleRelayEvent()

RedisBagOStuff::modifySimpleRelayEvent ( array $event )

Modify a cache update operation array for EventRelayer::notify()

This is used for relayed writes, e.g. for broadcasting a change to multiple data-centers. If the array contains a 'val' field then the command involves setting a key to that value. Note that for simplicity, 'val' is always a simple scalar value. This method is used to possibly serialize the value and add any cache-specific key/values needed for the relayer daemon (e.g. memcached flags).

Parameters

array $event

Returns: array

Since: 1.26

Reimplemented from BagOStuff.

Definition at line 325 of file RedisBagOStuff.php.

References serialize().

◆ serialize()

RedisBagOStuff::serialize ( $data )

protected

Parameters

mixed $data

Returns: string

Definition at line 337 of file RedisBagOStuff.php.

References serialize().

◆ set()

RedisBagOStuff::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 118 of file RedisBagOStuff.php.

References $e, $result, BagOStuff\convertToRelative(), getConnection(), handleException(), list, logRequest(), and serialize().

◆ setMulti()

RedisBagOStuff::setMulti	(	array	$data,
			$expiry = 0 )

Parameters

array	$data
int	$expiry

Returns: bool

Reimplemented from BagOStuff.

Definition at line 202 of file RedisBagOStuff.php.

References $e, $result, $value, BagOStuff\convertToRelative(), BagOStuff\debug(), getConnection(), handleException(), list, and serialize().

◆ unserialize()

RedisBagOStuff::unserialize ( $data )

protected

Parameters

string $data

Returns: mixed

Definition at line 347 of file RedisBagOStuff.php.

References string, and unserialize().

Referenced by getMulti(), getWithToken(), and unserialize().

Member Data Documentation

◆ $automaticFailover

bool RedisBagOStuff::$automaticFailover

protected

Definition at line 40 of file RedisBagOStuff.php.

◆ $redisPool

RedisConnectionPool RedisBagOStuff::$redisPool

protected

Definition at line 34 of file RedisBagOStuff.php.

◆ $servers

array RedisBagOStuff::$servers

protected

List of server names.

Definition at line 36 of file RedisBagOStuff.php.

◆ $serverTagMap

array RedisBagOStuff::$serverTagMap

protected

Map of (tag => server name)

Definition at line 38 of file RedisBagOStuff.php.

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

includes/libs/objectcache/RedisBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ changeTTL()

◆ delete()

◆ doGet()

◆ getConnection()

◆ getMasterLinkStatus()

◆ getMulti()

◆ getWithToken()

◆ handleException()

◆ incr()

◆ logError()

◆ logRequest()

◆ merge()

◆ modifySimpleRelayEvent()

◆ serialize()

◆ set()

◆ setMulti()

◆ unserialize()

Member Data Documentation

◆ $automaticFailover

◆ $redisPool

◆ $servers

◆ $serverTagMap