MediaWiki  master
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=[])
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 clearLastError ()
 
 delete ( $key, $flags=0)
 
 deleteObjectsExpiringBefore ( $date, $progressCallback=false)
 
 get ( $key, $flags=0)
 
 getLastError ()
 
 incr ( $key, $value=1)
 
 lock ( $key, $timeout=6, $expiry=6, $rclass='')
 
 makeGlobalKey ( $class, $component=null)
 
 makeKey ( $class, $component=null)
 
 makeKeyInternal ( $keyspace, $args)
 
 set ( $key, $value, $exptime=0, $flags=0)
 
 setDebug ( $bool)
 
 unlock ( $key)
 
- Public Member Functions inherited from HashBagOStuff
 __construct ( $params=[])
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 clear ()
 Clear all values in cache. More...
 
 incr ( $key, $value=1)
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 $params 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...
 
 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 ( $date, $progressCallback=false)
 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 ( $bool)
 
 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 Attributes

BagOStuff $backend
 
- Protected Attributes inherited from HashBagOStuff
mixed [] $bag = []
 
int $maxCacheKeys
 Max entries allowed. More...
 
- Protected Attributes inherited from BagOStuff
callable 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 $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...
 

Additional Inherited Members

- Public Attributes inherited from HashBagOStuff
const KEY_CAS = 2
 
const KEY_EXP = 1
 
const KEY_VAL = 0
 
- Public Attributes inherited from BagOStuff
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_ALLOW_SEGMENTS = 16
 
const WRITE_CACHE_ONLY = 8
 
const WRITE_PRUNE_SEGMENTS = 32
 
const WRITE_SYNC = 4
 Bitfield constants for set()/merge() 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
 
- Protected Member Functions inherited from HashBagOStuff
 doDelete ( $key, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
 doSet ( $key, $value, $exptime=0, $flags=0)
 
 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, $flags=0)
 Check and set an item. More...
 
 convertToExpiry ( $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)
 
 doDelete ( $key, $flags=0)
 Delete an item. More...
 
 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...
 
 expiryIsRelative ( $exptime)
 
 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, $flags=0)
 
 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)
 

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

: Make this class use composition instead of calling super

Definition at line 37 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 45 of file CachedBagOStuff.php.

References $backend, and $params.

Member Function Documentation

◆ add()

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

Definition at line 105 of file CachedBagOStuff.php.

References $value.

◆ clearLastError()

CachedBagOStuff::clearLastError ( )

Definition at line 132 of file CachedBagOStuff.php.

◆ delete()

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

Definition at line 71 of file CachedBagOStuff.php.

◆ deleteObjectsExpiringBefore()

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

Definition at line 85 of file CachedBagOStuff.php.

◆ get()

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

Definition at line 54 of file CachedBagOStuff.php.

References $ret, and HashBagOStuff\hasKey().

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ getLastError()

CachedBagOStuff::getLastError ( )

Definition at line 128 of file CachedBagOStuff.php.

◆ incr()

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

Definition at line 113 of file CachedBagOStuff.php.

◆ lock()

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

Definition at line 120 of file CachedBagOStuff.php.

◆ makeGlobalKey()

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

Definition at line 98 of file CachedBagOStuff.php.

◆ makeKey()

◆ makeKeyInternal()

CachedBagOStuff::makeKeyInternal (   $keyspace,
  $args 
)

Definition at line 90 of file CachedBagOStuff.php.

◆ set()

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

Definition at line 63 of file CachedBagOStuff.php.

◆ setDebug()

CachedBagOStuff::setDebug (   $bool)

Definition at line 80 of file CachedBagOStuff.php.

◆ unlock()

CachedBagOStuff::unlock (   $key)

Definition at line 124 of file CachedBagOStuff.php.

Member Data Documentation

◆ $backend

BagOStuff CachedBagOStuff::$backend
protected

Definition at line 39 of file CachedBagOStuff.php.

Referenced by __construct().


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