MediaWiki  master
MemcachedPeclBagOStuff Class Reference

A wrapper class for the PECL memcached client. More...

Inheritance diagram for MemcachedPeclBagOStuff:
Collaboration diagram for MemcachedPeclBagOStuff:

Public Member Functions

 __construct ( $params)
 Available parameters are: More...
 
 decr ( $key, $value=1, $flags=0)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 incr ( $key, $value=1, $flags=0)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 setNewPreparedValues (array $valueByKey)
 Prepare values for storage and get their serialized sizes, or, estimate those sizes. More...
 
- Public Member Functions inherited from MemcachedBagOStuff
 __construct (array $params)
 
 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
 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...
 
 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)
 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...
 
 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
 getCurrentTime ()
 
 getLogger ()
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getWithSetCallback ( $key, $exptime, $callback, $flags=0)
 Get an item with the given key, regenerating and setting it if not found. More...
 
 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. More...
 
 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)
 
 serialize ( $value)
 
 unserialize ( $value)
 
- Protected Member Functions inherited from MemcachedBagOStuff
 fixExpiry ( $exptime)
 
- Protected Member Functions inherited from MediumSpecificBagOStuff
 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Check and set an item. More...
 
 debug ( $text)
 
 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...
 
 getSerialized ( $value, $key)
 Get the serialized form a value, using any applicable prepared value. More...
 
 guessSerialValueSize ( $value, $depth=0, &$loops=0)
 Estimate the size of a variable once serialized. 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...
 
 setLastError ( $err)
 Set the "last error" registry. More...
 
- 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

Memcached null $asyncClient
 
bool $hasUnflushedChanges = false
 Whether the non-buffering client should be flushed before use. More...
 
Memcached $syncClient
 
bool $syncClientIsBuffering = false
 Whether the non-buffering client is locked from use. 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...
 
array[] $preparedValues = []
 Map of (key => (PHP variable value, serialized value)) 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

 acquireAsyncClient ()
 
 acquireSyncClient ()
 
 initializeClient (Memcached $client, array $params, array $options)
 Initialize the client only if needed and reuse it otherwise. More...
 
 releaseAsyncClient ( $client)
 

Static Private Attributes

static array $OPTS_ASYNC_WRITES
 Memcached options. More...
 
static array $OPTS_SYNC_WRITES
 Memcached options. 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...
 

Detailed Description

A wrapper class for the PECL memcached client.

Definition at line 29 of file MemcachedPeclBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedPeclBagOStuff::__construct (   $params)

Available parameters are:

  • servers: List of IP:port combinations holding the memcached servers.
  • persistent: Whether to use a persistent connection
  • compress_threshold: The minimum size an object must be before it is compressed
  • timeout: The read timeout in microseconds
  • connect_timeout: The connect timeout in seconds
  • retry_timeout: Time in seconds to wait before retrying a failed connect attempt
  • server_failure_limit: Limit for server connect failures before it is removed
  • serializer: Either "php" or "igbinary". Igbinary produces more compact values, but serialization is much slower unless the php.ini option igbinary.compact_strings is off.
  • use_binary_protocol Whether to enable the binary protocol (default is ASCII)
  • allow_tcp_nagle_delay Whether to permit Nagle's algorithm for reducing packet count
    Parameters
    array$params

Definition at line 67 of file MemcachedPeclBagOStuff.php.

References $asyncClient, $syncClient, initializeClient(), serialize(), and true.

Member Function Documentation

◆ acquireAsyncClient()

MemcachedPeclBagOStuff::acquireAsyncClient ( )
private
Returns
Memcached

Definition at line 452 of file MemcachedPeclBagOStuff.php.

References $asyncClient, and $syncClient.

Referenced by doDeleteMulti(), and doSetMulti().

◆ acquireSyncClient()

MemcachedPeclBagOStuff::acquireSyncClient ( )
private
Returns
Memcached

Definition at line 432 of file MemcachedPeclBagOStuff.php.

References $syncClient.

Referenced by decr(), doAdd(), doCas(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().

◆ checkResult()

MemcachedPeclBagOStuff::checkResult (   $key,
  $result 
)
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.

Parameters
string$keyThe key used by the caller, or false if there wasn't one.
mixed$resultThe return value
Returns
mixed

Definition at line 295 of file MemcachedPeclBagOStuff.php.

References $syncClient, MediumSpecificBagOStuff\debug(), and MediumSpecificBagOStuff\setLastError().

Referenced by decr(), doAdd(), doCas(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doSet(), doSetMulti(), and incr().

◆ decr()

MemcachedPeclBagOStuff::decr (   $key,
  $value = 1,
  $flags = 0 
)

Decrease stored value of $key by $value while preserving its TTL.

Parameters
string$key
int$valueValue to subtract from $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 266 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), and MediumSpecificBagOStuff\debug().

◆ doAdd()

MemcachedPeclBagOStuff::doAdd (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 246 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doCas()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 222 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doChangeTTL()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 391 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\fixExpiry().

◆ doDelete()

MemcachedPeclBagOStuff::doDelete (   $key,
  $flags = 0 
)
protected

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 234 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), true, and MemcachedBagOStuff\validateKeyEncoding().

◆ doDeleteMulti()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 363 of file MemcachedPeclBagOStuff.php.

References $keys, acquireAsyncClient(), acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), BagOStuff\fieldHasFlags(), releaseAsyncClient(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doGet()

MemcachedPeclBagOStuff::doGet (   $key,
  $flags = 0,
$casToken = null 
)
protected
Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
mixed | null&$casTokencas() token if MediumSpecificBagOStuff::PASS_BY_REF [returned]
Returns
mixed Returns false on failure or if the item does not exist

Reimplemented from MediumSpecificBagOStuff.

Definition at line 180 of file MemcachedPeclBagOStuff.php.

References $res, acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doGetMulti()

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

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

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 327 of file MemcachedPeclBagOStuff.php.

References $keys, acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doSet()

MemcachedPeclBagOStuff::doSet (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 206 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), true, and MemcachedBagOStuff\validateKeyEncoding().

◆ doSetMulti()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 342 of file MemcachedPeclBagOStuff.php.

References acquireAsyncClient(), acquireSyncClient(), checkResult(), MediumSpecificBagOStuff\debug(), BagOStuff\fieldHasFlags(), MemcachedBagOStuff\fixExpiry(), releaseAsyncClient(), and MemcachedBagOStuff\validateKeyEncoding().

◆ incr()

MemcachedPeclBagOStuff::incr (   $key,
  $value = 1,
  $flags = 0 
)

Increase stored value of $key by $value while preserving its TTL.

Parameters
string$keyKey to increase
int$valueValue to add to $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 258 of file MemcachedPeclBagOStuff.php.

References acquireSyncClient(), checkResult(), and MediumSpecificBagOStuff\debug().

◆ initializeClient()

MemcachedPeclBagOStuff::initializeClient ( Memcached  $client,
array  $params,
array  $options 
)
private

Initialize the client only if needed and reuse it otherwise.

This avoids duplicate servers in the list and new connections.

Parameters
Memcached$client
array$params
array$optionsBase options for Memcached::setOptions()
Exceptions
RuntimeException

Definition at line 115 of file MemcachedPeclBagOStuff.php.

References true.

Referenced by __construct().

◆ releaseAsyncClient()

MemcachedPeclBagOStuff::releaseAsyncClient (   $client)
private
Parameters
Memcached$client

Definition at line 467 of file MemcachedPeclBagOStuff.php.

Referenced by doDeleteMulti(), and doSetMulti().

◆ serialize()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 399 of file MemcachedPeclBagOStuff.php.

Referenced by __construct().

◆ setNewPreparedValues()

MemcachedPeclBagOStuff::setNewPreparedValues ( array  $valueByKey)

Prepare values for storage and get their serialized sizes, or, estimate those sizes.

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:

$valueByKey = [ $key1 => $value1, $key2 => $value2, $key3 => $value3 ];
$cache->setNewPreparedValues( $valueByKey );
$cache->set( $key1, $value1, $cache::TTL_HOUR );
$cache->setMulti( [ $key2 => $value2, $key3 => $value3 ], $cache::TTL_HOUR );

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.

Parameters
array$valueByKeyMap of (cache key => PHP variable value to serialize)
Returns
int[]|null[] Corresponding list of size estimates (null for invalid values)
Since
1.35

Reimplemented from MediumSpecificBagOStuff.

Definition at line 274 of file MemcachedPeclBagOStuff.php.

References MediumSpecificBagOStuff\guessSerialValueSize().

◆ unserialize()

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 414 of file MemcachedPeclBagOStuff.php.

References MediumSpecificBagOStuff\isInteger().

Member Data Documentation

◆ $asyncClient

Memcached null MemcachedPeclBagOStuff::$asyncClient
protected

Definition at line 33 of file MemcachedPeclBagOStuff.php.

Referenced by __construct(), and acquireAsyncClient().

◆ $hasUnflushedChanges

bool MemcachedPeclBagOStuff::$hasUnflushedChanges = false
protected

Whether the non-buffering client should be flushed before use.

Definition at line 38 of file MemcachedPeclBagOStuff.php.

◆ $OPTS_ASYNC_WRITES

array MemcachedPeclBagOStuff::$OPTS_ASYNC_WRITES
staticprivate
Initial value:
= [
Memcached::OPT_NO_BLOCK => true,
Memcached::OPT_BUFFER_WRITES => true
]

Memcached options.

Definition at line 46 of file MemcachedPeclBagOStuff.php.

◆ $OPTS_SYNC_WRITES

array MemcachedPeclBagOStuff::$OPTS_SYNC_WRITES
staticprivate
Initial value:
= [
Memcached::OPT_NO_BLOCK => false,
Memcached::OPT_BUFFER_WRITES => false
]

Memcached options.

Definition at line 41 of file MemcachedPeclBagOStuff.php.

◆ $syncClient

Memcached MemcachedPeclBagOStuff::$syncClient
protected

◆ $syncClientIsBuffering

bool MemcachedPeclBagOStuff::$syncClientIsBuffering = false
protected

Whether the non-buffering client is locked from use.

Definition at line 36 of file MemcachedPeclBagOStuff.php.


The documentation for this class was generated from the following file:
true
return true
Definition: router.php:90
$cache
$cache
Definition: mcc.php:33