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...
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 decr ( $key, $value=1)
 
 incr ( $key, $value=1)
 
- 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
 __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,... $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...
 
 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,... $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)
 
 checkResult ( $key, $result)
 Check the return value from a client method call and take any necessary action. More...
 
 doChangeTTL ( $key, $exptime, $flags)
 
 doDelete ( $key, $flags=0)
 
 doDeleteMulti (array $keys, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
 doGetMulti (array $keys, $flags=0)
 
 doSet ( $key, $value, $exptime=0, $flags=0)
 
 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)
 
 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)
 
 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

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...
 
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...
 
- 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

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, $params, $syncClient, initializeClient(), null, serialize(), and true.

Member Function Documentation

◆ acquireAsyncClient()

MemcachedPeclBagOStuff::acquireAsyncClient ( )
private
Returns
Memcached

Definition at line 435 of file MemcachedPeclBagOStuff.php.

References $asyncClient, and $syncClient.

Referenced by doDeleteMulti(), and doSetMulti().

◆ acquireSyncClient()

MemcachedPeclBagOStuff::acquireSyncClient ( )
private
Returns
Memcached

Definition at line 415 of file MemcachedPeclBagOStuff.php.

References $syncClient.

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

◆ add()

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

◆ cas()

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

◆ 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 280 of file MemcachedPeclBagOStuff.php.

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

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

◆ decr()

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

◆ doChangeTTL()

MemcachedPeclBagOStuff::doChangeTTL (   $key,
  $exptime,
  $flags 
)
protected

◆ doDelete()

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

◆ doDeleteMulti()

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

◆ doGet()

MemcachedPeclBagOStuff::doGet (   $key,
  $flags = 0,
$casToken = null 
)
protected

◆ doGetMulti()

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

◆ doSet()

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

◆ doSetMulti()

MemcachedPeclBagOStuff::doSetMulti ( array  $data,
  $exptime = 0,
  $flags = 0 
)
protected

◆ incr()

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

◆ 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 as, false, and true.

Referenced by __construct().

◆ releaseAsyncClient()

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

Definition at line 450 of file MemcachedPeclBagOStuff.php.

Referenced by doDeleteMulti(), and doSetMulti().

◆ serialize()

MemcachedPeclBagOStuff::serialize (   $value)
protected

Definition at line 382 of file MemcachedPeclBagOStuff.php.

References $value.

Referenced by __construct().

◆ unserialize()

MemcachedPeclBagOStuff::unserialize (   $value)
protected

Definition at line 397 of file MemcachedPeclBagOStuff.php.

References $value, and 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 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 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: