MediaWiki  master
RedisBagOStuff Class Reference

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

Inheritance diagram for RedisBagOStuff:
Collaboration diagram for RedisBagOStuff:

Public Member Functions

 __construct ( $params)
 Construct a RedisBagOStuff object. More...
 
 add ( $key, $value, $expiry=0, $flags=0)
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 
 incr ( $key, $value=1)
 
 logRequest ( $op, $keys, $server, $e=null)
 Send information about a single request to the debug log. More...
 
- Public Member Functions inherited from MediumSpecificBagOStuff
 __construct (array $params=[])
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ( $key, $exptime=0, $flags=0)
 Change the expiration on a key if it exists. More...
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 Change the expiration of multiple keys that exist. More...
 
 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, $flags=0)
 Delete an item. More...
 
 deleteMulti (array $keys, $flags=0)
 Batch deletion. More...
 
 deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF)
 Delete all objects expiring before a certain date. More...
 
 get ( $key, $flags=0)
 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...
 
 getQoS ( $flag)
 
 getSegmentationSize ()
 
 getSegmentedValueMaxSize ()
 
 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 ( $class, $component=null)
 Make a global cache key. More...
 
 makeKey ( $class, $component=null)
 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...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setMulti (array $data, $exptime=0, $flags=0)
 Batch insertion/replace. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 Parameters include: More...
 
 add ( $key, $value, $exptime=0, $flags=0)
 Insert an item if it does not already exist. More...
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ( $key, $exptime=0, $flags=0)
 Change the expiration on a key if it exists. More...
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 Change the expiration of multiple keys that exist. More...
 
 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, $flags=0)
 Delete an item. More...
 
 deleteMulti (array $keys, $flags=0)
 Batch deletion. More...
 
 deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF)
 Delete all objects expiring before a certain date. More...
 
 get ( $key, $flags=0)
 Get an item with the given key. More...
 
 getCurrentTime ()
 
 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...
 
 getQoS ( $flag)
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getSegmentationSize ()
 
 getSegmentedValueMaxSize ()
 
 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 ( $class, $component=null)
 Make a global cache key. More...
 
 makeKey ( $class, $component=null)
 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...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setDebug ( $enabled)
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0, $flags=0)
 Batch insertion/replace. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 

Protected Member Functions

 doChangeTTL ( $key, $exptime, $flags)
 
 doDelete ( $key, $flags=0)
 
 doDeleteMulti (array $keys, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
 doGetMulti (array $keys, $flags=0)
 
 doSet ( $key, $value, $exptime=0, $flags=0)
 
 doSetMulti (array $data, $exptime=0, $flags=0)
 
 getConnection ( $key)
 
 handleException (RedisConnRef $conn, RedisException $e)
 The redis extension throws an exception in response to various read, write and protocol errors. More...
 
 logError ( $msg)
 Log a fatal error. More...
 
- Protected Member Functions inherited from MediumSpecificBagOStuff
 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Check and set an item. More...
 
 convertToExpiry ( $exptime)
 Convert an optionally relative timestamp to an absolute time. More...
 
 convertToRelative ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ( $text)
 
 doChangeTTL ( $key, $exptime, $flags)
 
 doDelete ( $key, $flags=0)
 Delete an item. More...
 
 doDeleteMulti (array $keys, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
 doGetMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 doSet ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 doSetMulti (array $data, $exptime=0, $flags=0)
 
 expiryIsRelative ( $exptime)
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)
 
 resolveSegments ( $key, $mainValue)
 Get and reassemble the chunks of blob at the given key. More...
 
 serialize ( $value)
 
 setLastError ( $err)
 Set the "last error" registry. More...
 
 unserialize ( $value)
 
- Protected Member Functions inherited from BagOStuff
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 

Protected Attributes

bool $automaticFailover
 
RedisConnectionPool $redisPool
 
array $servers
 List of server names. More...
 
array $serverTagMap
 Map of (tag => server name) More...
 
- Protected Attributes inherited from MediumSpecificBagOStuff
callable [] $busyCallbacks = []
 
string $keyspace = 'local'
 
int $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array [] $locks = []
 Lock tracking. More...
 
int $segmentationSize
 Bytes; chunk size of segmented cache values. More...
 
int $segmentedValueMaxSize
 Bytes; maximum total size of a segmented cache value. More...
 
int $syncTimeout
 Seconds. More...
 
- Protected Attributes inherited from BagOStuff
callable null $asyncHandler
 
int [] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
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. More...
 
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. More...
 
- 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
 

Detailed Description

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

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

Definition at line 31 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 69 of file RedisBagOStuff.php.

References $opt, $params, as, servers, and RedisConnectionPool\singleton().

Member Function Documentation

◆ add()

RedisBagOStuff::add (   $key,
  $value,
  $expiry = 0,
  $flags = 0 
)

◆ changeTTLMulti()

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

◆ doChangeTTL()

RedisBagOStuff::doChangeTTL (   $key,
  $exptime,
  $flags 
)
protected

◆ doDelete()

RedisBagOStuff::doDelete (   $key,
  $flags = 0 
)
protected

Definition at line 137 of file RedisBagOStuff.php.

References $e, false, getConnection(), handleException(), logRequest(), and null.

◆ doDeleteMulti()

RedisBagOStuff::doDeleteMulti ( array  $keys,
  $flags = 0 
)
protected

Definition at line 250 of file RedisBagOStuff.php.

References $e, as, getConnection(), handleException(), logRequest(), and null.

◆ doGet()

RedisBagOStuff::doGet (   $key,
  $flags = 0,
$casToken = null 
)
protected

◆ doGetMulti()

RedisBagOStuff::doGetMulti ( array  $keys,
  $flags = 0 
)
protected

◆ doSet()

RedisBagOStuff::doSet (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

◆ doSetMulti()

RedisBagOStuff::doSetMulti ( array  $data,
  $exptime = 0,
  $flags = 0 
)
protected

◆ getConnection()

RedisBagOStuff::getConnection (   $key)
protected
Parameters
string$key
Returns
RedisConnRef|Redis|null Redis handle wrapper for the key or null on failure

Definition at line 416 of file RedisBagOStuff.php.

References $e, ArrayUtils\consistentHashSort(), IExpiringStore\ERR_UNREACHABLE, null, servers, and MediumSpecificBagOStuff\setLastError().

Referenced by add(), changeTTLMulti(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().

◆ handleException()

RedisBagOStuff::handleException ( RedisConnRef  $conn,
RedisException  $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
RedisException$e

Definition at line 480 of file RedisBagOStuff.php.

References IExpiringStore\ERR_UNEXPECTED, and MediumSpecificBagOStuff\setLastError().

Referenced by add(), changeTTLMulti(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().

◆ incr()

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

Definition at line 364 of file RedisBagOStuff.php.

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

◆ logError()

RedisBagOStuff::logError (   $msg)
protected

Log a fatal error.

Parameters
string$msg

Definition at line 468 of file RedisBagOStuff.php.

◆ logRequest()

RedisBagOStuff::logRequest (   $op,
  $keys,
  $server,
  $e = null 
)

Send information about a single request to the debug log.

Parameters
string$op
string$keys
string$server
Exception | bool | null$e

Definition at line 492 of file RedisBagOStuff.php.

References $e, and MediumSpecificBagOStuff\debug().

Referenced by add(), changeTTLMulti(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().

Member Data Documentation

◆ $automaticFailover

bool RedisBagOStuff::$automaticFailover
protected

Definition at line 39 of file RedisBagOStuff.php.

◆ $redisPool

RedisConnectionPool RedisBagOStuff::$redisPool
protected

Definition at line 33 of file RedisBagOStuff.php.

◆ $servers

array RedisBagOStuff::$servers
protected

List of server names.

Definition at line 35 of file RedisBagOStuff.php.

◆ $serverTagMap

array RedisBagOStuff::$serverTagMap
protected

Map of (tag => server name)

Definition at line 37 of file RedisBagOStuff.php.


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