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)
 
 changeTTL ( $key, $expiry=0, $flags=0)
 
 decr ( $key, $value=1)
 
 delete ( $key, $flags=0)
 
 getMulti (array $keys, $flags=0)
 
 incr ( $key, $value=1)
 
 set ( $key, $value, $exptime=0, $flags=0)
 
 setMulti (array $data, $exptime=0, $flags=0)
 
- Public Member Functions inherited from MemcachedBagOStuff
 __construct (array $params)
 
 add ( $key, $value, $exptime=0, $flags=0)
 
 changeTTL ( $key, $exptime=0, $flags=0)
 
 decr ( $key, $value=1)
 
 delete ( $key, $flags=0)
 
 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...
 
 getClient ()
 Get the underlying client object. More...
 
 incr ( $key, $value=1)
 
 makeKeyInternal ( $keyspace, $args)
 Construct a cache key. More...
 
 set ( $key, $value, $exptime=0, $flags=0)
 
 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 BagOStuff
 __construct (array $params=[])
 $params 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, $expiry=0, $flags=0)
 Change the expiration on a key if it exists. 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 ( $date, $progressCallback=false)
 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)
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 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 ( $bool)
 
 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

 applyDefaultParams ( $params)
 
 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...
 
 doGet ( $key, $flags=0, &$casToken=null)
 PhanTypeNonVarPassByRef More...
 
- Protected Member Functions inherited from MemcachedBagOStuff
 applyDefaultParams ( $params)
 Fill in some defaults for missing keys in $params. More...
 
 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
- Protected Member Functions inherited from BagOStuff
 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Check and set an item. More...
 
 convertToExpiry ( $exptime)
 Convert an optionally relative time to an absolute time. More...
 
 convertToRelative ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ( $text)
 
 doGet ( $key, $flags=0, &$casToken=null)
 
 expiryIsRelative ( $exptime)
 
 getCurrentTime ()
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 mergeViaCas ( $key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ( $err)
 Set the "last error" registry. More...
 

Additional Inherited Members

- Public Attributes inherited from BagOStuff
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_CACHE_ONLY = 8
 
const WRITE_SYNC = 4
 Bitfield constants for set()/merge() 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 Attributes inherited from MemcachedBagOStuff
MemcachedClient Memcached $client
 
- Protected Attributes inherited from BagOStuff
callable null $asyncHandler
 
int [] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
callable [] $busyCallbacks = []
 
string $keyspace = 'local'
 
int $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array [] $locks = []
 Lock tracking. More...
 
LoggerInterface $logger
 
int $syncTimeout
 Seconds. 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: The 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: May be 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) (boolean)
    Parameters
    array$params
    Exceptions
    InvalidArgumentException

Definition at line 47 of file MemcachedPeclBagOStuff.php.

References $params, applyDefaultParams(), as, false, and serialize().

Member Function Documentation

◆ add()

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

Definition at line 188 of file MemcachedPeclBagOStuff.php.

References add, checkResult(), and BagOStuff\debug().

◆ applyDefaultParams()

MemcachedPeclBagOStuff::applyDefaultParams (   $params)
protected

Definition at line 127 of file MemcachedPeclBagOStuff.php.

References $params.

Referenced by __construct().

◆ cas()

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

Definition at line 173 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

◆ changeTTL()

MemcachedPeclBagOStuff::changeTTL (   $key,
  $expiry = 0,
  $flags = 0 
)

Definition at line 263 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

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

References BagOStuff\debug(), IExpiringStore\ERR_UNEXPECTED, and BagOStuff\setLastError().

Referenced by add(), cas(), changeTTL(), decr(), delete(), doGet(), getMulti(), incr(), set(), and setMulti().

◆ decr()

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

Definition at line 199 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

◆ delete()

MemcachedPeclBagOStuff::delete (   $key,
  $flags = 0 
)

Definition at line 178 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

◆ doGet()

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

PhanTypeNonVarPassByRef

Definition at line 144 of file MemcachedPeclBagOStuff.php.

References $res, checkResult(), class, BagOStuff\debug(), null, and MemcachedBagOStuff\validateKeyEncoding().

◆ getMulti()

MemcachedPeclBagOStuff::getMulti ( array  $keys,
  $flags = 0 
)

◆ incr()

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

Definition at line 193 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

◆ set()

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

Definition at line 163 of file MemcachedPeclBagOStuff.php.

References checkResult(), and BagOStuff\debug().

◆ setMulti()

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

The documentation for this class was generated from the following file: