MediaWiki  master
MultiWriteBagOStuff Class Reference

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

Inheritance diagram for MultiWriteBagOStuff:
Collaboration diagram for MultiWriteBagOStuff:

Public Member Functions

 __construct ( $params)
 $params include: More...
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 addBusyCallback (callable $workCallback)
 
 changeTTL ( $key, $exptime=0, $flags=0)
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 
 clearLastError ()
 
 decr ( $key, $value=1, $flags=0)
 
 delete ( $key, $flags=0)
 
 deleteMulti (array $data, $flags=0)
 
 deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF)
 
 get ( $key, $flags=0)
 
 getLastError ()
 
 getMulti (array $keys, $flags=0)
 
 incr ( $key, $value=1, $flags=0)
 
 incrWithInit ( $key, $exptime, $value=1, $init=null, $flags=0)
 
 lock ( $key, $timeout=6, $expiry=6, $rclass='')
 
 makeGlobalKey ( $class,... $components)
 Make a global cache key. More...
 
 makeKey ( $class,... $components)
 Make a cache key, scoped to this instance's keyspace. More...
 
 makeKeyInternal ( $keyspace, $args)
 
 merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
 
 set ( $key, $value, $exptime=0, $flags=0)
 
 setDebug ( $enabled)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0, $flags=0)
 
 unlock ( $key)
 
- 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, $flags=0)
 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, $flags=0)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 incrWithInit ( $key, $exptime, $value=1, $init=null, $flags=0)
 Increase the value of the given key (no TTL change) if it exists or create it otherwise. More...
 
 lock ( $key, $timeout=6, $expiry=6, $rclass='')
 Acquire an advisory lock on a key string. More...
 
 makeGlobalKey ( $class,... $components)
 Make a global cache key. More...
 
 makeKey ( $class,... $components)
 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

 doWrite ( $indexes, $asyncWrites, $method, array $args)
 Apply a write method to the backing caches specified by $indexes (in order) More...
 
 usesAsyncWritesGivenFlags ( $flags)
 
- Protected Member Functions inherited from BagOStuff
 fieldHasFlags ( $field, $flags)
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 

Protected Attributes

bool $asyncWrites = false
 Use async secondary writes. More...
 
int [] $cacheIndexes = []
 List of all backing cache indexes. More...
 
BagOStuff [] $caches
 
- Protected Attributes inherited from BagOStuff
callable null $asyncHandler
 
int [] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
bool $debugMode = false
 
LoggerInterface $logger
 

Static Private Attributes

static int $UPGRADE_TTL = 3600
 TTL when a key is copied to a higher cache tier. More...
 

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

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 yielding 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. To use 'async' writes requires the 'asyncHandler' option to be set as well. 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-param array{caches:array<int,array|BagOStuff>,replication:string} $params
    Exceptions
    InvalidArgumentException

Definition at line 67 of file MultiWriteBagOStuff.php.

References BagOStuff\mergeFlagMaps().

Member Function Documentation

◆ add()

MultiWriteBagOStuff::add (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)

Definition at line 163 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ addBusyCallback()

MultiWriteBagOStuff::addBusyCallback ( callable  $workCallback)

Definition at line 366 of file MultiWriteBagOStuff.php.

◆ changeTTL()

MultiWriteBagOStuff::changeTTL (   $key,
  $exptime = 0,
  $flags = 0 
)

Definition at line 196 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ changeTTLMulti()

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

Definition at line 261 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ clearLastError()

MultiWriteBagOStuff::clearLastError ( )

Definition at line 301 of file MultiWriteBagOStuff.php.

◆ decr()

MultiWriteBagOStuff::decr (   $key,
  $value = 1,
  $flags = 0 
)

Definition at line 279 of file MultiWriteBagOStuff.php.

References doWrite().

◆ delete()

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

Definition at line 154 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ deleteMulti()

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

Definition at line 252 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ deleteObjectsExpiringBefore()

MultiWriteBagOStuff::deleteObjectsExpiringBefore (   $timestamp,
callable  $progress = null,
  $limit = INF 
)

Definition at line 215 of file MultiWriteBagOStuff.php.

References $cache.

◆ 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$methodMethod name of backing caches
array$argsArguments to the method of backing caches
Returns
bool

Definition at line 314 of file MultiWriteBagOStuff.php.

References BagOStuff\$asyncHandler, $cache, BagOStuff\$logger, serialize(), and unserialize().

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

◆ get()

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

Definition at line 109 of file MultiWriteBagOStuff.php.

References $cache, doWrite(), and BagOStuff\fieldHasFlags().

◆ getLastError()

MultiWriteBagOStuff::getLastError ( )

Definition at line 297 of file MultiWriteBagOStuff.php.

◆ getMulti()

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

Definition at line 230 of file MultiWriteBagOStuff.php.

References $res.

◆ incr()

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

Definition at line 270 of file MultiWriteBagOStuff.php.

References doWrite().

◆ incrWithInit()

MultiWriteBagOStuff::incrWithInit (   $key,
  $exptime,
  $value = 1,
  $init = null,
  $flags = 0 
)

Definition at line 288 of file MultiWriteBagOStuff.php.

References doWrite().

◆ lock()

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

Definition at line 205 of file MultiWriteBagOStuff.php.

◆ makeGlobalKey()

MultiWriteBagOStuff::makeGlobalKey (   $class,
  $components 
)

Make a global cache key.

Parameters
string$classKey class
string...$components Key components (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components

Implements IStoreKeyEncoder.

Definition at line 362 of file MultiWriteBagOStuff.php.

◆ makeKey()

MultiWriteBagOStuff::makeKey (   $class,
  $components 
)

Make a cache key, scoped to this instance's keyspace.

Parameters
string$classKey class
string...$components Key components (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components

Implements IStoreKeyEncoder.

Definition at line 358 of file MultiWriteBagOStuff.php.

◆ makeKeyInternal()

MultiWriteBagOStuff::makeKeyInternal (   $keyspace,
  $args 
)

Definition at line 354 of file MultiWriteBagOStuff.php.

References $args.

◆ merge()

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

Definition at line 187 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ set()

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

Definition at line 145 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ setDebug()

MultiWriteBagOStuff::setDebug (   $enabled)

Definition at line 102 of file MultiWriteBagOStuff.php.

References $cache.

◆ setMockTime()

MultiWriteBagOStuff::setMockTime ( $time)

Definition at line 370 of file MultiWriteBagOStuff.php.

References $cache.

◆ setMulti()

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

Definition at line 243 of file MultiWriteBagOStuff.php.

References doWrite(), and usesAsyncWritesGivenFlags().

◆ unlock()

MultiWriteBagOStuff::unlock (   $key)

Definition at line 210 of file MultiWriteBagOStuff.php.

◆ usesAsyncWritesGivenFlags()

MultiWriteBagOStuff::usesAsyncWritesGivenFlags (   $flags)
protected
Parameters
int$flags
Returns
bool

Definition at line 350 of file MultiWriteBagOStuff.php.

References $asyncWrites, and BagOStuff\fieldHasFlags().

Referenced by add(), changeTTL(), changeTTLMulti(), 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 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

int MultiWriteBagOStuff::$UPGRADE_TTL = 3600
staticprivate

TTL when a key is copied to a higher cache tier.

Definition at line 44 of file MultiWriteBagOStuff.php.


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