MediaWiki  master
MediumSpecificBagOStuff Class Reference

Storage medium specific cache for storing items (e.g. More...

Inheritance diagram for MediumSpecificBagOStuff:
Collaboration diagram for MediumSpecificBagOStuff:

Public Member Functions

 __construct (array $params=[])
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 addBusyCallback (callable $workCallback)
 
 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...
 
 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, $exptime, $value=1, $init=null, $flags=0)
 
 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)
 
 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, $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

 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Check and set an item. More...
 
 debug ( $text)
 
 doAdd ( $key, $value, $exptime=0, $flags=0)
 Insert an item if it does not already exist. More...
 
 doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Check and set an item. More...
 
 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)
 
 getExpirationAsTimestamp ( $exptime)
 Convert an optionally relative timestamp to an absolute time. More...
 
 getExpirationAsTTL ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 isRelativeExpiration ( $exptime)
 
 makeValueOrSegmentList ( $key, $value, $exptime, $flags)
 Determine the entry (inline or segment list) to store under a key to save the value. 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
 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

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
 

Private Member Functions

 trackDuplicateKeys ( $key)
 Track the number of times that a given key has been used. More...
 

Private Attributes

bool $dupeTrackScheduled = false
 
array $duplicateKeyLookups = []
 
bool $reportDupes = false
 

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

Storage medium specific cache for storing items (e.g.

redis, memcached, ...)

This should not be used for proxy classes that simply wrap other cache instances

Since
1.34

Definition at line 34 of file MediumSpecificBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MediumSpecificBagOStuff::__construct ( array  $params = [])
See also
BagOStuff::__construct() Additional $params options include:
  • logger: Psr\Log\LoggerInterface instance
  • keyspace: Default keyspace for $this->makeKey()
  • reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
  • syncTimeout: How long to wait with WRITE_SYNC in seconds.
  • segmentationSize: The chunk size, in bytes, of segmented values. The value should not exceed the maximum size of values in the storage backend, as configured by the site administrator.
  • segmentedValueMaxSize: The maximum total size, in bytes, of segmented values. This should be configured to a reasonable size give the site traffic and the amount of I/O between application and cache servers that the network can handle.
Parameters
array$params-param array{logger?:Psr\Log\LoggerInterface,asyncHandler?:callable,keyspace?:string,reportDupes?:bool,syncTimeout?:int,segmentationSize?:int,segmentedValueMaxSize?:int} $params

Definition at line 80 of file MediumSpecificBagOStuff.php.

Member Function Documentation

◆ add()

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

◆ addBusyCallback()

MediumSpecificBagOStuff::addBusyCallback ( callable  $workCallback)
final

Definition at line 756 of file MediumSpecificBagOStuff.php.

◆ cas()

MediumSpecificBagOStuff::cas (   $casToken,
  $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

Check and set an item.

Parameters
mixed$casToken
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

Definition at line 335 of file MediumSpecificBagOStuff.php.

References doCas(), and makeValueOrSegmentList().

Referenced by mergeViaCas().

◆ changeTTL()

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

Change the expiration on a key if it exists.

If an expiry in the past is given then the key will immediately be expired

For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.

Parameters
string$key
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success Returns false on failure or if the item does not exist
Since
1.28

Definition at line 412 of file MediumSpecificBagOStuff.php.

References doChangeTTL().

◆ changeTTLMulti()

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

Change the expiration of multiple keys that exist.

Parameters
string[]$keys List of keys
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success
See also
BagOStuff::changeTTL()
Since
1.34

Definition at line 668 of file MediumSpecificBagOStuff.php.

References $res, and doChangeTTL().

◆ clearLastError()

MediumSpecificBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since
1.23

Definition at line 743 of file MediumSpecificBagOStuff.php.

Referenced by doCas(), incrWithInit(), lock(), and mergeViaCas().

◆ debug()

◆ delete()

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

Delete an item.

For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.

Parameters
string$key
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool True if the item was deleted or not found, false on failure

Definition at line 193 of file MediumSpecificBagOStuff.php.

References deleteMulti(), doDelete(), doGet(), BagOStuff\fieldHasFlags(), SerializedValueContainer\isSegmented(), makeGlobalKey(), and SerializedValueContainer\SEGMENTED_HASHES.

Referenced by MemcLockManager\releaseMutexes().

◆ deleteMulti()

MediumSpecificBagOStuff::deleteMulti ( array  $keys,
  $flags = 0 
)

Batch deletion.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

Parameters
string[]$keys List of keys
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Since
1.33

Definition at line 636 of file MediumSpecificBagOStuff.php.

References doDeleteMulti(), and BagOStuff\fieldHasFlags().

Referenced by delete().

◆ deleteObjectsExpiringBefore()

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

Delete all objects expiring before a certain date.

Parameters
string | int$timestampThe reference date in MW or TS_UNIX format
callable | null$progressOptional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional]
int$limitMaximum number of keys to delete [default: INF]
Returns
bool Success; false if unimplemented

Definition at line 542 of file MediumSpecificBagOStuff.php.

◆ doAdd()

MediumSpecificBagOStuff::doAdd (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
abstractprotected

Insert an item if it does not already exist.

Parameters
string$key
mixed$value
int$exptime
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success

Referenced by add().

◆ doCas()

MediumSpecificBagOStuff::doCas (   $casToken,
  $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

Check and set an item.

Parameters
mixed$casToken
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

Definition at line 360 of file MediumSpecificBagOStuff.php.

References $success, clearLastError(), doGet(), doSet(), getLastError(), lock(), and unlock().

Referenced by cas().

◆ doChangeTTL()

MediumSpecificBagOStuff::doChangeTTL (   $key,
  $exptime,
  $flags 
)
protected
Parameters
string$key
int$exptime
int$flags
Returns
bool

Definition at line 422 of file MediumSpecificBagOStuff.php.

References $blob, doDelete(), doGet(), doSet(), BagOStuff\getCurrentTime(), getExpirationAsTimestamp(), lock(), and unlock().

Referenced by changeTTL(), and changeTTLMulti().

◆ doDelete()

MediumSpecificBagOStuff::doDelete (   $key,
  $flags = 0 
)
abstractprotected

Delete an item.

Parameters
string$key
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool True if the item was deleted or not found, false on failure

Referenced by delete(), doChangeTTL(), doDeleteMulti(), and unlock().

◆ doDeleteMulti()

MediumSpecificBagOStuff::doDeleteMulti ( array  $keys,
  $flags = 0 
)
protected
Parameters
string[]$keys List of keys
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Definition at line 649 of file MediumSpecificBagOStuff.php.

References $res, and doDelete().

Referenced by deleteMulti().

◆ doGet()

MediumSpecificBagOStuff::doGet (   $key,
  $flags = 0,
$casToken = null 
)
abstractprotected
Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
mixed | null&$casTokenToken to use for check-and-set comparisons
Returns
mixed Returns false on failure or if the item does not exist

Referenced by delete(), doCas(), doChangeTTL(), doGetMulti(), get(), mergeViaCas(), and trackDuplicateKeys().

◆ doGetMulti()

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

Get an associative array containing the item for each of the keys that have items.

Parameters
string[]$keys List of keys
int$flagsBitfield; supports READ_LATEST [optional]
Returns
array Map of (key => value) for existing keys

Definition at line 580 of file MediumSpecificBagOStuff.php.

References $res, and doGet().

Referenced by getMulti(), and resolveSegments().

◆ doSet()

MediumSpecificBagOStuff::doSet (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
abstractprotected

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

Referenced by doCas(), doChangeTTL(), doSetMulti(), and set().

◆ doSetMulti()

MediumSpecificBagOStuff::doSetMulti ( array  $data,
  $exptime = 0,
  $flags = 0 
)
protected
Parameters
mixed[]$data Map of (key => value)
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Definition at line 617 of file MediumSpecificBagOStuff.php.

References $res, and doSet().

Referenced by setMulti().

◆ get()

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

Get an item with the given key.

If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.

Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure or if the item does not exist

Definition at line 109 of file MediumSpecificBagOStuff.php.

References doGet(), resolveSegments(), and trackDuplicateKeys().

◆ getExpirationAsTimestamp()

MediumSpecificBagOStuff::getExpirationAsTimestamp (   $exptime)
finalprotected

Convert an optionally relative timestamp to an absolute time.

The input value will be cast to an integer and interpreted as follows:

  • zero: no expiry; return zero (e.g. TTL_INDEFINITE)
  • negative: relative TTL; return UNIX timestamp offset by this value
  • positive (< 10 years): relative TTL; return UNIX timestamp offset by this value
  • positive (>= 10 years): absolute UNIX timestamp; return this value
Parameters
int$exptime
Returns
int Expiration timestamp or TTL_INDEFINITE for indefinite
Since
1.34

Definition at line 835 of file MediumSpecificBagOStuff.php.

References BagOStuff\getCurrentTime(), and isRelativeExpiration().

Referenced by RedisBagOStuff\changeTTLMulti(), SqlBagOStuff\doCas(), RedisBagOStuff\doChangeTTL(), doChangeTTL(), HashBagOStuff\doSet(), and SqlBagOStuff\modifyMulti().

◆ getExpirationAsTTL()

MediumSpecificBagOStuff::getExpirationAsTTL (   $exptime)
finalprotected

Convert an optionally absolute expiry time to a relative time.

If an absolute time is specified which is in the past, use a short expiry time.

The input value will be cast to an integer and interpreted as follows:

  • zero: no expiry; return zero (e.g. TTL_INDEFINITE)
  • negative: relative TTL; return a short expiry time (1 second)
  • positive (< 10 years): relative TTL; return this value
  • positive (>= 10 years): absolute UNIX timestamp; return offset to current time
Parameters
int$exptime
Returns
int Relative TTL or TTL_INDEFINITE for indefinite
Since
1.34

Definition at line 859 of file MediumSpecificBagOStuff.php.

References BagOStuff\getCurrentTime(), and isRelativeExpiration().

Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doAdd(), RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doSet(), and RedisBagOStuff\doSetMulti().

◆ getLastError()

MediumSpecificBagOStuff::getLastError ( )

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

Returns
int ERR_* constant for the "last error" registry
Since
1.23

Definition at line 735 of file MediumSpecificBagOStuff.php.

References $lastError.

Referenced by doCas(), incrWithInit(), lock(), and mergeViaCas().

◆ getMulti()

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

Get an associative array containing the item for each of the keys that have items.

Parameters
string[]$keys List of keys; can be a map of (unused => key) for convenience
int$flagsBitfield; supports READ_LATEST [optional]
Returns
mixed[] Map of (key => value) for existing keys; preserves the order of $keys

Definition at line 556 of file MediumSpecificBagOStuff.php.

References $res, doGetMulti(), and resolveSegments().

◆ getQoS()

MediumSpecificBagOStuff::getQoS (   $flag)
Parameters
int$flagATTR_* class constant
Returns
int QOS_* class constant
Since
1.28

Definition at line 924 of file MediumSpecificBagOStuff.php.

◆ getSegmentationSize()

MediumSpecificBagOStuff::getSegmentationSize ( )

Definition at line 928 of file MediumSpecificBagOStuff.php.

References $segmentationSize.

◆ getSegmentedValueMaxSize()

MediumSpecificBagOStuff::getSegmentedValueMaxSize ( )

Definition at line 932 of file MediumSpecificBagOStuff.php.

References $segmentedValueMaxSize.

◆ incrWithInit()

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

Definition at line 677 of file MediumSpecificBagOStuff.php.

References add(), clearLastError(), getLastError(), and BagOStuff\incr().

◆ isInteger()

MediumSpecificBagOStuff::isInteger (   $value)
finalprotected

◆ isRelativeExpiration()

MediumSpecificBagOStuff::isRelativeExpiration (   $exptime)
finalprotected
Parameters
int | float$exptime
Returns
bool Whether the expiry is non-infinite, and, negative or not a UNIX timestamp
Since
1.34

Definition at line 818 of file MediumSpecificBagOStuff.php.

Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doChangeTTL(), MemcachedBagOStuff\fixExpiry(), getExpirationAsTimestamp(), and getExpirationAsTTL().

◆ lock()

MediumSpecificBagOStuff::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

Definition at line 458 of file MediumSpecificBagOStuff.php.

References add(), clearLastError(), and getLastError().

Referenced by doCas(), and doChangeTTL().

◆ makeGlobalKey()

MediumSpecificBagOStuff::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
Since
1.27

Implements IStoreKeyEncoder.

Definition at line 903 of file MediumSpecificBagOStuff.php.

References makeKeyInternal().

Referenced by delete(), makeValueOrSegmentList(), and resolveSegments().

◆ makeKey()

MediumSpecificBagOStuff::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
Since
1.27

Implements IStoreKeyEncoder.

Definition at line 915 of file MediumSpecificBagOStuff.php.

References makeKeyInternal().

◆ makeKeyInternal()

MediumSpecificBagOStuff::makeKeyInternal (   $keyspace,
  $args 
)

Definition at line 887 of file MediumSpecificBagOStuff.php.

References $args, and $keyspace.

Referenced by makeGlobalKey(), and makeKey().

◆ makeValueOrSegmentList()

MediumSpecificBagOStuff::makeValueOrSegmentList (   $key,
  $value,
  $exptime,
  $flags 
)
finalprotected

Determine the entry (inline or segment list) to store under a key to save the value.

Parameters
string$key
mixed$value
int$exptime
int$flags
Returns
array (inline value or segment list, whether the entry is usable)
Since
1.34

Definition at line 770 of file MediumSpecificBagOStuff.php.

References $segmentationSize, $segmentedValueMaxSize, $serialized, BagOStuff\fieldHasFlags(), makeGlobalKey(), SerializedValueContainer\newSegmented(), SerializedValueContainer\newUnified(), serialize(), setMulti(), and BagOStuff\WRITE_ALLOW_SEGMENTS.

Referenced by add(), cas(), and set().

◆ merge()

MediumSpecificBagOStuff::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. Nothing is stored nor deleted if the callback returns false.

Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Definition at line 259 of file MediumSpecificBagOStuff.php.

References mergeViaCas().

◆ mergeViaCas()

MediumSpecificBagOStuff::mergeViaCas (   $key,
callable  $callback,
  $exptime,
  $attempts,
  $flags 
)
finalprotected
Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
See also
BagOStuff::merge()

Definition at line 272 of file MediumSpecificBagOStuff.php.

References $success, add(), cas(), clearLastError(), doGet(), getLastError(), and resolveSegments().

Referenced by merge().

◆ resolveSegments()

MediumSpecificBagOStuff::resolveSegments (   $key,
  $mainValue 
)
finalprotected

Get and reassemble the chunks of blob at the given key.

Parameters
string$key
mixed$mainValue
Returns
string|null|bool The combined string, false if missing, null on error

Definition at line 700 of file MediumSpecificBagOStuff.php.

References doGetMulti(), SerializedValueContainer\isSegmented(), SerializedValueContainer\isUnified(), makeGlobalKey(), SerializedValueContainer\SEGMENTED_HASHES, SerializedValueContainer\UNIFIED_DATA, and unserialize().

Referenced by get(), getMulti(), and mergeViaCas().

◆ serialize()

MediumSpecificBagOStuff::serialize (   $value)
protected
Parameters
mixed$value
Returns
string|int String/integer representation
Note
Special handling is usually needed for integers so incr()/decr() work

Definition at line 941 of file MediumSpecificBagOStuff.php.

Referenced by APCBagOStuff\doAdd(), APCUBagOStuff\doAdd(), WinCacheBagOStuff\doAdd(), RedisBagOStuff\doAdd(), APCBagOStuff\doSet(), APCUBagOStuff\doSet(), WinCacheBagOStuff\doSet(), RedisBagOStuff\doSet(), RedisBagOStuff\doSetMulti(), RESTBagOStuff\encodeBody(), and makeValueOrSegmentList().

◆ set()

MediumSpecificBagOStuff::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

Definition at line 165 of file MediumSpecificBagOStuff.php.

References doSet(), and makeValueOrSegmentList().

◆ setLastError()

MediumSpecificBagOStuff::setLastError (   $err)
protected

Set the "last error" registry.

Parameters
int$errERR_* constant
Since
1.23

Definition at line 752 of file MediumSpecificBagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\getConnection(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), and SqlBagOStuff\setAndLogDBError().

◆ setMulti()

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

Batch insertion/replace.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

Parameters
mixed[]$data Map of (key => value)
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success
Since
1.24

Definition at line 603 of file MediumSpecificBagOStuff.php.

References doSetMulti(), and BagOStuff\fieldHasFlags().

Referenced by makeValueOrSegmentList().

◆ trackDuplicateKeys()

MediumSpecificBagOStuff::trackDuplicateKeys (   $key)
private

Track the number of times that a given key has been used.

Parameters
string$key

Definition at line 119 of file MediumSpecificBagOStuff.php.

References doGet().

Referenced by get().

◆ unlock()

MediumSpecificBagOStuff::unlock (   $key)

Release an advisory lock on a key string.

Parameters
string$key
Returns
bool Success

Definition at line 510 of file MediumSpecificBagOStuff.php.

References doDelete().

Referenced by doCas(), and doChangeTTL().

◆ unserialize()

MediumSpecificBagOStuff::unserialize (   $value)
protected
Parameters
string | int$value
Returns
mixed Original value or false on error
Note
Special handling is usually needed for integers so incr()/decr() work

Definition at line 950 of file MediumSpecificBagOStuff.php.

References isInteger().

Referenced by RESTBagOStuff\decodeBody(), WinCacheBagOStuff\doGet(), APCBagOStuff\doGet(), APCUBagOStuff\doGet(), RedisBagOStuff\doGet(), RedisBagOStuff\doGetMulti(), and resolveSegments().

Member Data Documentation

◆ $busyCallbacks

callable [] MediumSpecificBagOStuff::$busyCallbacks = []
protected

Definition at line 56 of file MediumSpecificBagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

◆ $dupeTrackScheduled

bool MediumSpecificBagOStuff::$dupeTrackScheduled = false
private

Definition at line 53 of file MediumSpecificBagOStuff.php.

◆ $duplicateKeyLookups

array MediumSpecificBagOStuff::$duplicateKeyLookups = []
private

Definition at line 49 of file MediumSpecificBagOStuff.php.

◆ $keyspace

string MediumSpecificBagOStuff::$keyspace = 'local'
protected

◆ $lastError

int MediumSpecificBagOStuff::$lastError = self::ERR_NONE
protected

ERR_* class constant.

Definition at line 38 of file MediumSpecificBagOStuff.php.

Referenced by getLastError().

◆ $locks

array [] MediumSpecificBagOStuff::$locks = []
protected

Lock tracking.

Definition at line 36 of file MediumSpecificBagOStuff.php.

◆ $reportDupes

bool MediumSpecificBagOStuff::$reportDupes = false
private

Definition at line 51 of file MediumSpecificBagOStuff.php.

◆ $segmentationSize

int MediumSpecificBagOStuff::$segmentationSize
protected

Bytes; chunk size of segmented cache values.

Definition at line 44 of file MediumSpecificBagOStuff.php.

Referenced by getSegmentationSize(), and makeValueOrSegmentList().

◆ $segmentedValueMaxSize

int MediumSpecificBagOStuff::$segmentedValueMaxSize
protected

Bytes; maximum total size of a segmented cache value.

Definition at line 46 of file MediumSpecificBagOStuff.php.

Referenced by getSegmentedValueMaxSize(), and makeValueOrSegmentList().

◆ $syncTimeout

int MediumSpecificBagOStuff::$syncTimeout
protected

Seconds.

Definition at line 42 of file MediumSpecificBagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().


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