MediaWiki master
|
Storage medium specific cache for storing items (e.g. More...
Inherits Wikimedia\ObjectCache\BagOStuff.
Inherited by SqlBagOStuff, Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and Wikimedia\ObjectCache\WinCacheBagOStuff.
Public Member Functions | |
__construct (array $params=[]) | |
add ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
changeTTL ( $key, $exptime=0, $flags=0) | |
Change the expiration on a key if it exists. | |
changeTTLMulti (array $keys, $exptime, $flags=0) | |
Change the expiration of multiple keys that exist. | |
delete ( $key, $flags=0) | |
Delete an item. | |
deleteMulti (array $keys, $flags=0) | |
Batch deletion. | |
deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF, string $tag=null) | |
Delete all objects expiring before a certain date. | |
get ( $key, $flags=0) | |
Get an item with the given key. | |
getMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
getQoS ( $flag) | |
getSegmentationSize () | |
getSegmentedValueMaxSize () | |
incrWithInit ( $key, $exptime, $step=1, $init=null, $flags=0) | |
Increase the value of the given key (no TTL change) if it exists or create it otherwise. | |
lock ( $key, $timeout=6, $exptime=6, $rclass='') | |
merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0) | |
Merge changes into the existing cache value (possibly creating a new one) | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
setMulti (array $valueByKey, $exptime=0, $flags=0) | |
Batch insertion/replace. | |
unlock ( $key) | |
Release an advisory lock on a key string. | |
![]() | |
clearLastError () | |
Clear the "last error" registry. | |
getCurrentTime () | |
getLastError ( $watchPoint=0) | |
Get the "last error" registry. | |
getLogger () | |
getScopedLock ( $key, $timeout=6, $exptime=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item, regenerating and setting it if not found. | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. | |
makeGlobalKey ( $keygroup,... $components) | |
Make a cache key from the given components, in the "global" keyspace. | |
makeKey ( $keygroup,... $components) | |
Make a cache key from the given components, in the default keyspace. | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
watchErrors () | |
Get a "watch point" token that can be used to get the "last error" to occur after now. | |
Protected Member Functions | |
cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Set an item if the current CAS token matches the provided CAS token. | |
debug ( $text) | |
doAdd ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
doCas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Set an item if the current CAS token matches the provided CAS token. | |
doChangeTTL ( $key, $exptime, $flags) | |
doChangeTTLMulti (array $keys, $exptime, $flags=0) | |
doDelete ( $key, $flags=0) | |
Delete an item. | |
doDeleteMulti (array $keys, $flags=0) | |
doGet ( $key, $flags=0, &$casToken=null) | |
Get an item. | |
doGetMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
doIncrWithInit ( $key, $exptime, $step, $init, $flags) | |
doLock ( $key, $timeout, $exptime) | |
doSet ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
doSetMulti (array $data, $exptime=0, $flags=0) | |
doUnlock ( $key) | |
getExpirationAsTimestamp ( $exptime) | |
Convert an optionally relative timestamp to an absolute time. | |
getExpirationAsTTL ( $exptime) | |
Convert an optionally absolute expiry time to a relative time. | |
getSerialized ( $value, $key) | |
Get the serialized form a value, logging a warning if it involves custom classes. | |
isInteger ( $value) | |
Check if a value is an integer. | |
isRelativeExpiration ( $exptime) | |
makeLockKey ( $key) | |
makeValueOrSegmentList ( $key, $value, $exptime, $flags, &$ok) | |
Make the entry to store at a key (inline or segment list), storing any segments. | |
mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags) | |
resolveSegments ( $key, $mainValue) | |
Get and reassemble the chunks of blob at the given key. | |
serialize ( $value) | |
tokensMatch ( $value, $otherValue) | |
unserialize ( $value) | |
updateOpStats (string $op, array $keyInfo) | |
![]() | |
fieldHasFlags ( $field, $flags) | |
makeKeyInternal ( $keyspace, $components) | |
Make a cache key for the given keyspace and components. | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. | |
proxyCall (string $method, int $arg0Sig, int $resSig, array $genericArgs, BagOStuff $wrapper) | |
Call a method on behalf of wrapper BagOStuff instance. | |
requireConvertGenericKey () | |
Whether ::proxyCall() must re-encode cache keys before calling read/write methods. | |
setLastError ( $error) | |
Set the "last error" registry due to a problem encountered during an attempted operation. | |
Protected Attributes | |
array< string, array > | $locks = [] |
Map of (key => (class LOCK_* constant => value) | |
float | $maxLockSendDelay = 0.05 |
Seconds; maximum expected seconds for a lock ping to reach the backend. | |
int | $segmentationSize |
Bytes; chunk size of segmented cache values. | |
int | $segmentedValueMaxSize |
Bytes; maximum total size of a segmented cache value. | |
const | LOCK_DEPTH = 1 |
const | LOCK_EXPIRY = 3 |
const | LOCK_RCLASS = 0 |
const | LOCK_TIME = 2 |
const | METRIC_OP_ADD = 'add' |
const | METRIC_OP_CAS = 'cas' |
const | METRIC_OP_CHANGE_TTL = 'change_ttl' |
const | METRIC_OP_DECR = 'decr' |
const | METRIC_OP_DELETE = 'delete' |
const | METRIC_OP_GET = 'get' |
const | METRIC_OP_INCR = 'incr' |
const | METRIC_OP_SET = 'set' |
const | PASS_BY_REF = -1 |
Idiom for doGet() to return extra information by reference. | |
![]() | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (BagOStuff:ATTR_* constant => BagOStuff:QOS_* constant) | |
string | $keyspace |
Default keyspace; used by makeKey() | |
int | $lastError = self::ERR_NONE |
BagOStuff:ERR_* constant of the last error that occurred. | |
int | $lastErrorId = 0 |
Error event sequence number of the last error that occurred. | |
LoggerInterface | $logger |
StatsFactory | $stats |
Additional Inherited Members | |
![]() | |
const | MAX_CONFLICTS_ONE = 1 |
Abort after the first merge conflict. | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. | |
const | READ_VERIFIED = 2 |
Promise that the caller handles detection of staleness. | |
const | WRITE_ALLOW_SEGMENTS = 16 |
Allow partitioning of the value if it is a large string. | |
const | WRITE_BACKGROUND = 64 |
If supported, do not block on write operation completion; instead, treat writes as succesful based on whether they could be buffered. | |
const | WRITE_CACHE_ONLY = 8 |
Bitfield constants for set()/merge(); these are only advisory. | |
const | WRITE_PRUNE_SEGMENTS = 32 |
Delete all the segments if the value is partitioned. | |
![]() | |
const | ATTR_DURABILITY = 2 |
Durability of writes; see QOS_DURABILITY_* (higher means stronger) | |
const | ATTR_EMULATION = 1 |
const | ERR_NO_RESPONSE = 1 |
Storage medium failed to yield a complete response to an operation. | |
const | ERR_NONE = 0 |
No storage medium error. | |
const | ERR_UNEXPECTED = 3 |
Storage medium operation failed due to usage limitations or an I/O error. | |
const | ERR_UNREACHABLE = 2 |
Storage medium could not be reached to establish a connection. | |
const | QOS_DURABILITY_DISK = 4 |
Data is saved to disk and writes do not usually block on fsync() | |
const | QOS_DURABILITY_NONE = 1 |
Data is never saved to begin with (blackhole store) | |
const | QOS_DURABILITY_RDBMS = 5 |
Data is saved to disk and writes usually block on fsync(), like a standard RDBMS. | |
const | QOS_DURABILITY_SCRIPT = 2 |
Data is lost at the end of the current web request or CLI script. | |
const | QOS_DURABILITY_SERVICE = 3 |
Data is lost once the service storing the data restarts. | |
const | QOS_UNKNOWN = INF |
Generic "unknown" value; useful for comparisons (always "good enough") | |
![]() | |
static int | $nextErrorMonitorId = 1 |
Next sequence number to use for watch/error events. | |
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
Definition at line 40 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::__construct | ( | array | $params = [] | ) |
array | $params |
@phpcs:ignore Generic.Files.LineLength
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Reimplemented in Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, and Wikimedia\ObjectCache\WinCacheBagOStuff.
Definition at line 96 of file MediumSpecificBagOStuff.php.
References $params.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::add | ( | $key, | |
$value, | |||
$exptime = 0, | |||
$flags = 0 ) |
Insert an item if it does not already exist.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 252 of file MediumSpecificBagOStuff.php.
Referenced by MemcLockManager\acquireMutexes().
|
protected |
Set an item if the current CAS token matches the provided CAS token.
mixed | $casToken | Only set the item if it still has this CAS token |
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Definition at line 368 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\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.
string | $key | |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 470 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::changeTTLMulti | ( | array | $keys, |
$exptime, | |||
$flags = 0 ) |
Change the expiration of multiple keys that exist.
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 819 of file MediumSpecificBagOStuff.php.
|
protected |
string | $text |
Definition at line 1156 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\MemcachedPeclBagOStuff\checkResult(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doAdd(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doCas(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doDelete(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doDeleteMulti(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doGet(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doGetMulti(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doIncrWithInitAsync(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doIncrWithInitSync(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doSet(), and Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doSetMulti().
Wikimedia\ObjectCache\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.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 217 of file MediumSpecificBagOStuff.php.
References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doDelete(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\doGet(), Wikimedia\ObjectCache\BagOStuff\fieldHasFlags(), SerializedValueContainer\isSegmented(), Wikimedia\ObjectCache\BagOStuff\makeGlobalKey(), and SerializedValueContainer\SEGMENTED_HASHES.
Referenced by MemcLockManager\releaseMutexes().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::deleteMulti | ( | array | $keys, |
$flags = 0 ) |
Batch deletion.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 785 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::deleteObjectsExpiringBefore | ( | $timestamp, | |
callable | $progress = null, | ||
$limit = INF, | |||
string | $tag = null ) |
Delete all objects expiring before a certain date.
string | int | $timestamp | The reference date in MW or TS_UNIX format |
callable | null | $progress | Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional] |
int | float | $limit | Maximum number of keys to delete [default: INF] |
string | null | $tag | Tag to purge a single shard only. This is only supported when server tags are used in configuration. |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Reimplemented in SqlBagOStuff.
Definition at line 683 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Insert an item if it does not already exist.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
|
protected |
Set an item if the current CAS token matches the provided CAS token.
mixed | $casToken | CAS token from an existing version of the key |
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
Definition at line 396 of file MediumSpecificBagOStuff.php.
References $success.
|
protected |
string | $key | |
int | $exptime | |
int | $flags |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.
Definition at line 481 of file MediumSpecificBagOStuff.php.
|
protected |
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.
Definition at line 830 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Delete an item.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\delete().
|
protected |
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.
Definition at line 799 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Get an item.
The CAS token should be null if the key does not exist or the value is corrupt
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
mixed | &$casToken | CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned] |
Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\delete(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\get().
|
protected |
Get an associative array containing the item for each of the keys that have items.
string[] | $keys | List of keys |
int | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.
Definition at line 726 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
string | $key | |
int | $exptime | |
int | $step | |
int | $init | |
int | $flags |
Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
|
protected |
string | $key | |
int | $timeout | Lock wait timeout; 0 for non-blocking [optional] |
int | $exptime | Lock time-to-live 1 day maximum [optional] |
Reimplemented in SqlBagOStuff.
Definition at line 570 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Set an item.
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\APCUBagOStuff, Wikimedia\ObjectCache\EmptyBagOStuff, Wikimedia\ObjectCache\HashBagOStuff, Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, Wikimedia\ObjectCache\RESTBagOStuff, Wikimedia\ObjectCache\WinCacheBagOStuff, and SqlBagOStuff.
Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\set().
|
protected |
mixed[] | $data | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\RedisBagOStuff, and SqlBagOStuff.
Definition at line 765 of file MediumSpecificBagOStuff.php.
|
protected |
string | $key |
Reimplemented in SqlBagOStuff.
Definition at line 646 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\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.
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 123 of file MediumSpecificBagOStuff.php.
References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doGet(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\resolveSegments().
|
finalprotected |
Convert an optionally relative timestamp to an absolute time.
The input value will be cast to an integer and interpreted as follows:
int | $exptime |
Definition at line 983 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), and Wikimedia\ObjectCache\HashBagOStuff\doSet().
|
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:
int | $exptime |
Definition at line 1008 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\APCUBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\WinCacheBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\APCUBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RedisBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\APCUBagOStuff\doSet(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), Wikimedia\ObjectCache\WinCacheBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::getMulti | ( | array | $keys, |
$flags = 0 ) |
Get an associative array containing the item for each of the keys that have items.
string[] | $keys | List of keys; can be a map of (unused => key) for convenience |
int | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 700 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::getQoS | ( | $flag | ) |
int | $flag | BagOStuff::ATTR_* constant |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 1037 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::getSegmentationSize | ( | ) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 1044 of file MediumSpecificBagOStuff.php.
References wfDeprecated().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::getSegmentedValueMaxSize | ( | ) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 1053 of file MediumSpecificBagOStuff.php.
References wfDeprecated().
|
protected |
Get the serialized form a value, logging a warning if it involves custom classes.
mixed | $value | |
string | $key |
Definition at line 1068 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\WinCacheBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), Wikimedia\ObjectCache\WinCacheBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::incrWithInit | ( | $key, | |
$exptime, | |||
$step = 1, | |||
$init = null, | |||
$flags = 0 ) |
Increase the value of the given key (no TTL change) if it exists or create it otherwise.
This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $step) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $step.
The new value is returned, except if the WRITE_BACKGROUND flag is given, in which case the handler may choose to return true to indicate that the operation has been dispatched.
string | $key | Key built via makeKey() or makeGlobalKey() |
int | $exptime | Time-to-live (in seconds) or a UNIX timestamp expiration |
int | $step | Amount to increase the key value by [default: 1] |
int | null | $init | Value to initialize the key to if it does not exist [default: $step] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 507 of file MediumSpecificBagOStuff.php.
|
finalprotected |
Check if a value is an integer.
mixed | $value |
Definition at line 1025 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\HashBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RESTBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\unserialize(), and Wikimedia\ObjectCache\MemcachedPhpBagOStuff\unserialize().
|
finalprotected |
int | float | $exptime |
Definition at line 965 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), and Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::lock | ( | $key, | |
$timeout = 6, | |||
$exptime = 6, | |||
$rclass = '' ) |
string | $key | |
int | $timeout | |
int | $exptime | |
string | $rclass |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 533 of file MediumSpecificBagOStuff.php.
|
protected |
|
finalprotected |
Make the entry to store at a key (inline or segment list), storing any segments.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | |
mixed | null | &$ok | Whether the entry is usable (e.g. no missing segments) [returned] |
Definition at line 924 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\set().
Wikimedia\ObjectCache\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 overridden in the callback. Nothing is stored nor deleted if the callback returns false.
string | $key | |
callable | $callback | Callback method to be executed |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $attempts | The amount of times to attempt a merge in case of failure |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Reimplemented in Wikimedia\ObjectCache\EmptyBagOStuff.
Definition at line 288 of file MediumSpecificBagOStuff.php.
|
finalprotected |
string | $key | |
callable | $callback | Callback method to be executed |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $attempts | The amount of times to attempt a merge in case of failure |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Definition at line 302 of file MediumSpecificBagOStuff.php.
References $success.
|
finalprotected |
Get and reassemble the chunks of blob at the given key.
string | $key | |
mixed | $mainValue |
Definition at line 847 of file MediumSpecificBagOStuff.php.
References SerializedValueContainer\isSegmented(), and SerializedValueContainer\SEGMENTED_HASHES.
Referenced by Wikimedia\ObjectCache\MediumSpecificBagOStuff\get().
|
protected |
mixed | $value |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, and SqlBagOStuff.
Definition at line 1139 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::set | ( | $key, | |
$value, | |||
$exptime = 0, | |||
$flags = 0 ) |
Set an item.
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 186 of file MediumSpecificBagOStuff.php.
References Wikimedia\ObjectCache\MediumSpecificBagOStuff\doSet(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\makeValueOrSegmentList().
Wikimedia\ObjectCache\MediumSpecificBagOStuff::setMulti | ( | array | $valueByKey, |
$exptime = 0, | |||
$flags = 0 ) |
Batch insertion/replace.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
mixed[] | $valueByKey | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 750 of file MediumSpecificBagOStuff.php.
|
finalprotected |
mixed | $value | CAS token for an existing key |
mixed | $otherValue | CAS token for an existing key |
Definition at line 435 of file MediumSpecificBagOStuff.php.
Wikimedia\ObjectCache\MediumSpecificBagOStuff::unlock | ( | $key | ) |
Release an advisory lock on a key string.
string | $key |
Reimplemented from Wikimedia\ObjectCache\BagOStuff.
Definition at line 613 of file MediumSpecificBagOStuff.php.
|
protected |
string | int | false | $value |
Reimplemented in Wikimedia\ObjectCache\MemcachedPeclBagOStuff, Wikimedia\ObjectCache\MemcachedPhpBagOStuff, and SqlBagOStuff.
Definition at line 1149 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\WinCacheBagOStuff\doGet(), and Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti().
|
protected |
string | $op | Operation name as a MediumSpecificBagOStuff::METRIC_OP_* constant |
array<int,string>|array<string,int[]> | $keyInfo Key list, if payload sizes are not applicable, otherwise, map of (key => (send payload size, receive payload size)); send and receive sizes are 0 where not applicable and receive sizes are "false" for keys that were not found during read operations |
Definition at line 1182 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doDelete(), Wikimedia\ObjectCache\RESTBagOStuff\doDelete(), Wikimedia\ObjectCache\RedisBagOStuff\doDeleteMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\RESTBagOStuff\doGet(), SqlBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti(), SqlBagOStuff\doGetMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), Wikimedia\ObjectCache\RESTBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().
|
protected |
Map of (key => (class LOCK_* constant => value)
Definition at line 42 of file MediumSpecificBagOStuff.php.
|
protected |
Seconds; maximum expected seconds for a lock ping to reach the backend.
Definition at line 49 of file MediumSpecificBagOStuff.php.
|
protected |
Bytes; chunk size of segmented cache values.
Definition at line 44 of file MediumSpecificBagOStuff.php.
|
protected |
Bytes; maximum total size of a segmented cache value.
Definition at line 46 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 74 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 76 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 73 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 75 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 68 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 71 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 67 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 70 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 66 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 64 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 69 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 65 of file MediumSpecificBagOStuff.php.
|
protected |
Idiom for doGet() to return extra information by reference.
Definition at line 62 of file MediumSpecificBagOStuff.php.
Referenced by Wikimedia\ObjectCache\WinCacheBagOStuff\doCas(), Wikimedia\ObjectCache\APCUBagOStuff\doGet(), Wikimedia\ObjectCache\HashBagOStuff\doGet(), Wikimedia\ObjectCache\MemcachedPeclBagOStuff\doGet(), Wikimedia\ObjectCache\MemcachedPhpBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\RESTBagOStuff\doGet(), and Wikimedia\ObjectCache\WinCacheBagOStuff\doGet().