MemcachedBagOStuff Class Reference
Base class for memcached clients. More...
Inheritance diagram for MemcachedBagOStuff:
Collaboration diagram for MemcachedBagOStuff:
Public Member Functions | |
| __construct (array $params) | |
| fixExpiry ( $expiry) | |
| TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the cache entry being discarded immediately because the expiry is in the past. More... | |
| makeKeyInternal ( $keyspace, $args) | |
| Construct a cache key. More... | |
| validateKeyEncoding ( $key) | |
| Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.) More... | |
 Public Member Functions inherited from MediumSpecificBagOStuff | |
| __construct (array $params=[]) | |
| 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) | |
| 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... | |
| 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, $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... | |
| 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) | |
| 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) | |
| 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 ( $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... | |
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 |
| Protected Member Functions inherited from MediumSpecificBagOStuff | |
| cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
| Check and set an item. More... | |
| convertToExpiry ( $exptime) | |
| Convert an optionally relative timestamp to an absolute time. More... | |
| convertToRelative ( $exptime) | |
| Convert an optionally absolute expiry time to a relative time. More... | |
| debug ( $text) | |
| 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) | |
| expiryIsRelative ( $exptime) | |
| isInteger ( $value) | |
| Check if a value is an integer. 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 | |
| mergeFlagMaps (array $bags) | |
| Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More... | |
| Protected Attributes inherited from MediumSpecificBagOStuff | |
| 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 |
Detailed Description
Base class for memcached clients.
Definition at line 29 of file MemcachedBagOStuff.php.
Constructor & Destructor Documentation
◆ __construct()
| MemcachedBagOStuff::__construct | ( | array | $params | ) |
Definition at line 30 of file MemcachedBagOStuff.php.
Member Function Documentation
◆ fixExpiry()
| MemcachedBagOStuff::fixExpiry | ( | $expiry | ) |
TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the cache entry being discarded immediately because the expiry is in the past.
Clamp expires >30d at 30d, unless they're >=1e9 in which case they are likely to really be absolute (1e9 = 2011-09-09)
- Parameters
-
int $expiry
- Returns
- int
Definition at line 107 of file MemcachedBagOStuff.php.
Referenced by MemcachedPhpBagOStuff\add(), MemcachedPeclBagOStuff\add(), MemcachedPhpBagOStuff\cas(), MemcachedPeclBagOStuff\cas(), MemcachedPhpBagOStuff\doChangeTTL(), MemcachedPeclBagOStuff\doChangeTTL(), MemcachedPhpBagOStuff\doSet(), MemcachedPeclBagOStuff\doSet(), and MemcachedPeclBagOStuff\doSetMulti().
◆ makeKeyInternal()
| MemcachedBagOStuff::makeKeyInternal | ( | $keyspace, | |
| $args | |||
| ) |
Construct a cache key.
- Since
- 1.27
- Parameters
-
string $keyspace array $args
- Returns
- string
Definition at line 45 of file MemcachedBagOStuff.php.
References $args, MediumSpecificBagOStuff\$keyspace, and use.
◆ validateKeyEncoding()
| MemcachedBagOStuff::validateKeyEncoding | ( | $key | ) |
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.)
- Parameters
-
string $key
- Returns
- string
- Exceptions
-
Exception
Definition at line 91 of file MemcachedBagOStuff.php.
Referenced by MemcachedPhpBagOStuff\add(), MemcachedPeclBagOStuff\add(), MemcachedPhpBagOStuff\cas(), MemcachedPeclBagOStuff\cas(), MemcachedPhpBagOStuff\decr(), MemcachedPhpBagOStuff\doChangeTTL(), MemcachedPhpBagOStuff\doDelete(), MemcachedPeclBagOStuff\doDelete(), MemcachedPeclBagOStuff\doDeleteMulti(), MemcachedPhpBagOStuff\doGet(), MemcachedPeclBagOStuff\doGet(), MemcachedPhpBagOStuff\doGetMulti(), MemcachedPeclBagOStuff\doGetMulti(), MemcachedPhpBagOStuff\doSet(), MemcachedPeclBagOStuff\doSet(), MemcachedPeclBagOStuff\doSetMulti(), and MemcachedPhpBagOStuff\incr().
The documentation for this class was generated from the following file:
- includes/libs/objectcache/MemcachedBagOStuff.php
