MediaWiki  REL1_31
CachedBagOStuff Class Reference

Wrapper around a BagOStuff that caches data in memory. More...

Inheritance diagram for CachedBagOStuff:
Collaboration diagram for CachedBagOStuff:

Public Member Functions

 __construct (BagOStuff $backend, $params=[])
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 delete ( $key, $flags=0)
 
 deleteObjectsExpiringBefore ( $date, $progressCallback=false)
 Delete all objects expiring before a certain date. More...
 
 getLastError ()
 Get the "last error" registered; clearLastError() should be called manually. 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...
 
 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)
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 
- Public Member Functions inherited from HashBagOStuff
 __construct ( $params=[])
 
 clear ()
 
 delete ( $key)
 Delete an item. More...
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 $params include: More...
 
 add ( $key, $value, $exptime=0)
 
 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...
 
 decr ( $key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 get ( $key, $flags=0, $oldFlags=null)
 Get an item with the given key. 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...
 
 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...
 
 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...
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0)
 Batch insertion. More...
 

Protected Member Functions

 doGet ( $key, $flags=0)
 
- Protected Member Functions inherited from HashBagOStuff
 expire ( $key)
 
 hasKey ( $key)
 Does this bag have a non-null value for the given key? More...
 
- 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)
 
 getCurrentTime ()
 
 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 $backend
 
- Protected Attributes inherited from HashBagOStuff
mixed[] $bag = []
 
int $maxCacheKeys
 Max entries allowed. More...
 
- 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 HashBagOStuff
const KEY_EXP = 1
 
const KEY_VAL = 0
 
- 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_SECOND = 1
 
const TTL_WEEK = 604800
 
const TTL_YEAR = 31536000
 

Detailed Description

Wrapper around a BagOStuff that caches data in memory.

The differences between CachedBagOStuff and MultiWriteBagOStuff are:

  • CachedBagOStuff supports only one "backend".
  • There's a flag for writes to only go to the in-memory cache.
  • The in-memory cache is always updated.
  • Locks go to the backend cache (with MultiWriteBagOStuff, it would wind up going to the HashBagOStuff used for the in-memory cache).

Definition at line 36 of file CachedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

CachedBagOStuff::__construct ( BagOStuff  $backend,
  $params = [] 
)
Parameters
BagOStuff$backendPermanent backend to use
array$paramsParameters for HashBagOStuff

Definition at line 44 of file CachedBagOStuff.php.

References $backend, and $params.

Member Function Documentation

◆ clearLastError()

CachedBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since
1.23

Reimplemented from BagOStuff.

Definition at line 112 of file CachedBagOStuff.php.

◆ delete()

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

Definition at line 70 of file CachedBagOStuff.php.

◆ deleteObjectsExpiringBefore()

CachedBagOStuff::deleteObjectsExpiringBefore (   $date,
  $progressCallback = false 
)

Delete all objects expiring before a certain date.

Parameters
string$dateThe reference date in MW format
callable | bool$progressCallbackOptional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter.
Returns
bool Success, false if unimplemented

Reimplemented from BagOStuff.

Definition at line 84 of file CachedBagOStuff.php.

◆ doGet()

CachedBagOStuff::doGet (   $key,
  $flags = 0 
)
protected
Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist

Reimplemented from HashBagOStuff.

Definition at line 53 of file CachedBagOStuff.php.

References $ret, HashBagOStuff\hasKey(), and BagOStuff\WRITE_CACHE_ONLY.

◆ getLastError()

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

◆ lock()

CachedBagOStuff::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$timeoutLock wait timeout; 0 for non-blocking [optional]
int$expiryLock expiry [optional]; 1 day maximum
string$rclassAllow reentry if set and the current lock used this value
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 100 of file CachedBagOStuff.php.

◆ makeGlobalKey()

CachedBagOStuff::makeGlobalKey (   $class,
  $component = null 
)

Make a global cache key.

Since
1.27
Parameters
string$classKey class
string$component[optional] Key component (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented from BagOStuff.

Definition at line 93 of file CachedBagOStuff.php.

◆ makeKey()

CachedBagOStuff::makeKey (   $class,
  $component = null 
)

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

Since
1.27
Parameters
string$classKey class
string$component[optional] Key component (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented from BagOStuff.

Definition at line 89 of file CachedBagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\TestBagOStuff\deleteSession(), MediaWiki\Session\TestBagOStuff\getSession(), MediaWiki\Session\TestBagOStuff\getSessionFromBackend(), and MediaWiki\Session\TestBagOStuff\setRawSession().

◆ modifySimpleRelayEvent()

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

◆ set()

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

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from HashBagOStuff.

Definition at line 62 of file CachedBagOStuff.php.

References $value.

◆ setDebug()

CachedBagOStuff::setDebug (   $bool)
Parameters
bool$bool

Reimplemented from BagOStuff.

Definition at line 79 of file CachedBagOStuff.php.

◆ unlock()

CachedBagOStuff::unlock (   $key)

Release an advisory lock on a key string.

Parameters
string$key
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 104 of file CachedBagOStuff.php.

Member Data Documentation

◆ $backend

BagOStuff CachedBagOStuff::$backend
protected

Definition at line 38 of file CachedBagOStuff.php.

Referenced by __construct().


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