MediaWiki REL1_37
|
A wrapper class for the PECL memcached client. More...
Public Member Functions | |
__construct ( $params) | |
Available parameters are: | |
decr ( $key, $value=1, $flags=0) | |
Decrease stored value of $key by $value while preserving its TTL. | |
incr ( $key, $value=1, $flags=0) | |
Increase stored value of $key by $value while preserving its TTL. | |
setNewPreparedValues (array $valueByKey) | |
Make a "generic" reversible cache key from the given components. | |
Public Member Functions inherited from MemcachedBagOStuff | |
__construct (array $params) | |
makeKeyInternal ( $keyspace, $components) | |
Construct a cache key. | |
validateKeyEncoding ( $key) | |
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.) | |
Public Member Functions inherited from MediumSpecificBagOStuff | |
add ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
addBusyCallback (callable $workCallback) | |
Let a callback be run to avoid wasting time on special blocking calls. | |
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. | |
clearLastError () | |
Clear the "last error" registry. | |
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. | |
getLastError () | |
Get the "last error" registered; clearLastError() should be called manually. | |
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, $value=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='') | |
makeGlobalKey ( $collection,... $components) | |
Make a cache key for the default keyspace and given components. | |
makeKey ( $collection,... $components) | |
Make a cache key for the global keyspace and given components. | |
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. | |
Public Member Functions inherited from BagOStuff | |
getCurrentTime () | |
getLogger () | |
getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item with the given key, regenerating and setting it if not found. | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. | |
registerWrapperInfoForStats (string $prefixComponent, string $statsGroup, callable $collectionCallback) | |
Register info about a caching layer class that uses BagOStuff as a backing store. | |
setDebug ( $enabled) | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
Protected Member Functions | |
checkResult ( $key, $result) | |
Check the return value from a client method call and take any necessary action. | |
doAdd ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
doCas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. | |
doChangeTTL ( $key, $exptime, $flags) | |
doDelete ( $key, $flags=0) | |
Delete an item. | |
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. | |
doSet ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
doSetMulti (array $data, $exptime=0, $flags=0) | |
serialize ( $value) | |
unserialize ( $value) | |
Protected Member Functions inherited from MemcachedBagOStuff | |
fixExpiry ( $exptime) | |
stripRouteFromKey ( $key) | |
validateKeyAndPrependRoute ( $key) | |
Protected Member Functions inherited from MediumSpecificBagOStuff | |
cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. | |
convertGenericKey ( $key) | |
Convert a "generic" reversible cache key into one for this cache. | |
debug ( $text) | |
doChangeTTLMulti (array $keys, $exptime, $flags=0) | |
doLock ( $key, $timeout, $exptime) | |
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, using any applicable prepared value. | |
guessSerialValueSize ( $value, $depth=0, &$loops=0) | |
Estimate the size of a variable once serialized. | |
isInteger ( $value) | |
Check if a value is an integer. | |
isRelativeExpiration ( $exptime) | |
makeLockKey ( $key) | |
makeValueOrSegmentList ( $key, $value, $exptime, $flags) | |
Determine the entry (inline or segment list) to store under a key to save the value. | |
mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags) | |
resolveSegments ( $key, $mainValue) | |
Get and reassemble the chunks of blob at the given key. | |
setLastError ( $err) | |
Set the "last error" registry. | |
updateOpStats (string $op, array $keyInfo) | |
Protected Member Functions inherited from BagOStuff | |
componentsFromGenericKey ( $key) | |
Extract the components from a "generic" reversible cache key. | |
determineKeyPrefixForStats ( $key) | |
fieldHasFlags ( $field, $flags) | |
genericKeyFromComponents (... $components) | |
At a minimum, there must be a keyspace and collection name component. | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. | |
proxyCall ( $method, $arg0Sig, $resSig, array $genericArgs) | |
Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys. | |
Protected Attributes | |
Memcached null | $asyncClient |
bool | $hasUnflushedChanges = false |
Whether the non-buffering client should be flushed before use. | |
Memcached | $syncClient |
bool | $syncClientIsBuffering = false |
Whether the non-buffering client is locked from use. | |
Protected Attributes inherited from MemcachedBagOStuff | |
string | $routingPrefix |
Routing prefix appended to keys during operations. | |
Protected Attributes inherited from MediumSpecificBagOStuff | |
callable[] | $busyCallbacks = [] |
int | $lastError = self::ERR_NONE |
ERR_* class constant. | |
array< string, array > | $locks = [] |
Map of (key => (class, depth, expiry) | |
array[] | $preparedValues = [] |
Map of (key => (PHP variable value, serialized value)) | |
int | $segmentationSize |
Bytes; chunk size of segmented cache values. | |
int | $segmentedValueMaxSize |
Bytes; maximum total size of a segmented cache value. | |
int | $syncTimeout |
Seconds. | |
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' |
Protected Attributes inherited from BagOStuff | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (ATTR_* class constant => QOS_* class constant) | |
bool | $debugMode = true |
Whether to send debug log entries to the SPI logger instance. | |
string | $keyspace |
Default keyspace; used by makeKey() | |
LoggerInterface | $logger |
StatsdDataFactoryInterface | $stats |
array< string, array > | $wrapperInfoByPrefix = [] |
Cache key processing callbacks and info for metrics. | |
Private Member Functions | |
acquireAsyncClient () | |
acquireSyncClient () | |
initializeClient (Memcached $client, array $params, array $options) | |
Initialize the client only if needed and reuse it otherwise. | |
releaseAsyncClient ( $client) | |
Static Private Attributes | |
static array | $OPTS_ASYNC_WRITES |
Memcached options. | |
static array | $OPTS_SYNC_WRITES |
Memcached options. | |
Additional Inherited Members | |
Public Attributes inherited from BagOStuff | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. | |
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. | |
Public Attributes inherited from Wikimedia\LightweightObjectStore\StorageAwareness | |
const | ATTR_DURABILITY = 2 |
Durability of writes; see QOS_DURABILITY_* (higher means stronger) | |
const | ATTR_EMULATION = 1 |
Emulation/fallback mode; see QOS_EMULATION_*; higher is better. | |
const | ERR_NO_RESPONSE = 1 |
Storage medium failed to yield a response. | |
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. | |
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_EMULATION_SQL = 1 |
Fallback disk-based SQL store. | |
const | QOS_UNKNOWN = INF |
Generic "unknown" value; useful for comparisons (always "good enough") | |
A wrapper class for the PECL memcached client.
Definition at line 29 of file MemcachedPeclBagOStuff.php.
MemcachedPeclBagOStuff::__construct | ( | $params | ) |
Available parameters are:
array | $params |
Definition at line 67 of file MemcachedPeclBagOStuff.php.
References $asyncClient, $syncClient, initializeClient(), serialize(), and true.
|
private |
Definition at line 473 of file MemcachedPeclBagOStuff.php.
References $asyncClient, and $syncClient.
Referenced by doDeleteMulti(), and doSetMulti().
|
private |
Definition at line 453 of file MemcachedPeclBagOStuff.php.
References $syncClient.
Referenced by decr(), doAdd(), doCas(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().
|
protected |
Check the return value from a client method call and take any necessary action.
Returns the value that the wrapper function should return. At present, the return value is always the same as the return value from the client, but some day we might find a case where it should be different.
string | $key | The key used by the caller, or false if there wasn't one. |
mixed | $result | The return value |
Definition at line 298 of file MemcachedPeclBagOStuff.php.
References $syncClient, MediumSpecificBagOStuff\debug(), Wikimedia\LightweightObjectStore\StorageAwareness\ERR_UNEXPECTED, and MediumSpecificBagOStuff\setLastError().
Referenced by decr(), doAdd(), doCas(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().
MemcachedPeclBagOStuff::decr | ( | $key, | |
$value = 1 , |
|||
$flags = 0 |
|||
) |
Decrease stored value of $key by $value while preserving its TTL.
string | $key | |
int | $value | Value to subtract from $key (default: 1) [optional] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented from BagOStuff.
Definition at line 268 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
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 MediumSpecificBagOStuff.
Definition at line 246 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
Check and set an item.
mixed | $casToken | |
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 MediumSpecificBagOStuff.
Definition at line 220 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
string | $key | |
int | $exptime | |
int | $flags |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 411 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
Delete an item.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 233 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), true, and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 382 of file MemcachedPeclBagOStuff.php.
References $keys, acquireAsyncClient(), acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), BagOStuff\fieldHasFlags(), releaseAsyncClient(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
mixed | null | &$casToken | cas() token if MediumSpecificBagOStuff::PASS_BY_REF [returned] |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 180 of file MemcachedPeclBagOStuff.php.
References $res, acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
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 from MediumSpecificBagOStuff.
Definition at line 330 of file MemcachedPeclBagOStuff.php.
References $keys, $res, acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\stripRouteFromKey(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
protected |
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 MediumSpecificBagOStuff.
Definition at line 207 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), true, and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
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 from MediumSpecificBagOStuff.
Definition at line 355 of file MemcachedPeclBagOStuff.php.
References acquireAsyncClient(), acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), BagOStuff\fieldHasFlags(), MemcachedBagOStuff\fixExpiry(), releaseAsyncClient(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
MemcachedPeclBagOStuff::incr | ( | $key, | |
$value = 1 , |
|||
$flags = 0 |
|||
) |
Increase stored value of $key by $value while preserving its TTL.
string | $key | Key to increase |
int | $value | Value to add to $key (default: 1) [optional] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented from BagOStuff.
Definition at line 259 of file MemcachedPeclBagOStuff.php.
References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyAndPrependRoute().
|
private |
Initialize the client only if needed and reuse it otherwise.
This avoids duplicate servers in the list and new connections.
Memcached | $client | |
array | $params | |
array | $options | Base options for Memcached::setOptions() |
RuntimeException |
Definition at line 115 of file MemcachedPeclBagOStuff.php.
References true.
Referenced by __construct().
|
private |
Memcached | $client |
Definition at line 488 of file MemcachedPeclBagOStuff.php.
Referenced by doDeleteMulti(), and doSetMulti().
|
protected |
mixed | $value |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 420 of file MemcachedPeclBagOStuff.php.
References serialize().
MemcachedPeclBagOStuff::setNewPreparedValues | ( | array | $valueByKey | ) |
Make a "generic" reversible cache key from the given components.
All previously prepared values will be cleared. Each of the new prepared values will be individually cleared as they get used by write operations for that key. This is done to avoid unchecked growth in PHP memory usage.
Example usage:
This is only useful if the caller needs an estimate of the serialized object sizes. The caller cannot know the serialization format and even if it did, it could be expensive to serialize complex values twice just to get the size information before writing them to cache. This method solves both problems by making the cache instance do the serialization and having it reuse the result when the cache write happens.
array | $valueByKey | Map of (cache key => PHP variable value to serialize) |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 277 of file MemcachedPeclBagOStuff.php.
References MediumSpecificBagOStuff\guessSerialValueSize().
|
protected |
string | int | false | $value |
Reimplemented from MediumSpecificBagOStuff.
Definition at line 435 of file MemcachedPeclBagOStuff.php.
References MediumSpecificBagOStuff\isInteger(), and unserialize().
Referenced by unserialize().
|
protected |
Definition at line 33 of file MemcachedPeclBagOStuff.php.
Referenced by __construct(), and acquireAsyncClient().
|
protected |
Whether the non-buffering client should be flushed before use.
Definition at line 38 of file MemcachedPeclBagOStuff.php.
|
staticprivate |
Memcached options.
Definition at line 46 of file MemcachedPeclBagOStuff.php.
|
staticprivate |
Memcached options.
Definition at line 41 of file MemcachedPeclBagOStuff.php.
|
protected |
Definition at line 31 of file MemcachedPeclBagOStuff.php.
Referenced by __construct(), acquireAsyncClient(), acquireSyncClient(), and checkResult().
|
protected |
Whether the non-buffering client is locked from use.
Definition at line 36 of file MemcachedPeclBagOStuff.php.