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

Inheritance diagram for MemcachedPeclBagOStuff:

[legend]

Collaboration diagram for MemcachedPeclBagOStuff:

[legend]

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)
	Stage a set of new key values for storage and estimate the amount of bytes needed.

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.

	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.

	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, $step=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
	clearLastError ()
	Clear the "last error" registry.

	getCurrentTime ()

	getLastError ( $watchPoint=0)
	Get the "last error" registry.

	getLogger ()

	getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.

	getWithSetCallback ( $key, $exptime, $callback, $flags=0)
	Get an item, 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.

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

	watchErrors ()
	Get a "watch point" token that can be used to get the "last error" to occur after now.

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)
	Set an item if the current CAS token matches the provided CAS token.

	doChangeTTL ( $key, $exptime, $flags)

	doDelete ( $key, $flags=0)
	Delete an item.

	doDeleteMulti (array $keys, $flags=0)

	doGet ( $key, $flags=0, &$casToken=null)
	Get an item.

	doGetMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	doIncrWithInitAsync ( $key, $exptime, $step, $init)

	doIncrWithInitSync ( $key, $exptime, $step, $init)

	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
	doIncrWithInit ( $key, $exptime, $step, $init, $flags)

	fixExpiry ( $exptime)

	stripRouteFromKey ( $key)

	validateKeyAndPrependRoute ( $key)

Protected Member Functions inherited from MediumSpecificBagOStuff
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Set an item if the current CAS token matches the provided CAS token.

	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.

	guessSerialSizeOfValues (array $values)
	Estimate the size of a each variable once serialized.

	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, &$ok)
	Make the entry to store at a key (inline or segment list), storing any segments.

	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)

	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key.

	tokensMatch ( $value, $otherValue)

	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 (string $method, int $arg0Sig, int $resSig, array $genericArgs, BagOStuff $wrapper)
	Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys.

	setLastError ( $error)
	Set the "last error" registry due to a problem encountered during an attempted operation.

Protected Attributes
Memcached	$client

Protected Attributes inherited from MemcachedBagOStuff
string	$routingPrefix
	Routing prefix appended to keys during operations.

Protected Attributes inherited from MediumSpecificBagOStuff
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.

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'

const	PASS_BY_REF = -1
	Idiom for doGet() to return extra information by reference.

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

int[]	$attrMap = []
	Map of (BagOStuff:ATTR_* constant => BagOStuff:QOS_* constant)

string	$keyspace
	Default keyspace; used by makeKey()

int	$lastError = self::ERR_NONE
	BagOStuff:ERR_* constant of the last error that occurred.

int	$lastErrorId = 0
	Error event sequence number of the last error that occurred.

LoggerInterface	$logger

StatsdDataFactoryInterface	$stats

array< string, array >	$wrapperInfoByPrefix = []
	Cache key processing callbacks and info for metrics.

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	MAX_CONFLICTS_ONE = 1
	Abort after the first merge conflict.

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.

const	READ_VERIFIED = 2
	Promise that the caller handles detection of staleness.

const	WRITE_ALLOW_SEGMENTS = 16
	Allow partitioning of the value if it is a large string.

const	WRITE_BACKGROUND = 64
	If supported, do not block on write operation completion; instead, treat writes as succesful based on whether they could be buffered.

const	WRITE_CACHE_ONLY = 8
	Bitfield constants for set()/merge(); these are only advisory.

const	WRITE_PRUNE_SEGMENTS = 32
	Delete all the segments if the value is partitioned.

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 complete response to an operation.

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 to establish a connection.

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")

Static Protected Attributes inherited from BagOStuff
static int	$nextErrorMonitorId = 1
	Next sequence number to use for watch/error events.

Detailed Description

A wrapper class for the PECL memcached client.

Definition at line 31 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 51 of file MemcachedPeclBagOStuff.php.

References serialize(), and true.

Member Function Documentation

◆ 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 \| false	$key	The key used by the caller, or false if there wasn't one.
mixed	$result	The return value

Returns: mixed

Definition at line 329 of file MemcachedPeclBagOStuff.php.

References MediumSpecificBagOStuff\debug(), and BagOStuff\setLastError().

Referenced by decr(), doAdd(), doCas(), doChangeTTL(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doIncrWithInitAsync(), doIncrWithInitSync(), 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	$value	Value to subtract from $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Deprecated: Since 1.38

Reimplemented from BagOStuff.

Definition at line 270 of file MemcachedPeclBagOStuff.php.

References checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyAndPrependRoute().

◆ 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	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 244 of file MemcachedPeclBagOStuff.php.

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

◆ doCas()

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

protected

Set an item if the current CAS token matches the provided CAS token.

Parameters

mixed	$casToken	CAS token from an existing version of the key
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 217 of file MemcachedPeclBagOStuff.php.

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

◆ doChangeTTL()

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

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented from MediumSpecificBagOStuff.

Definition at line 443 of file MemcachedPeclBagOStuff.php.

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

◆ doDelete()

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

protected

Delete an item.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool True if the item was deleted or not found, false on failure

Reimplemented from MediumSpecificBagOStuff.

Definition at line 230 of file MemcachedPeclBagOStuff.php.

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

◆ doDeleteMulti()

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

protected

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 420 of file MemcachedPeclBagOStuff.php.

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

◆ doGet()

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

protected

Get an item.

The CAS token should be null if the key does not exist or the value is corrupt

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed	&$casToken	CAS 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 176 of file MemcachedPeclBagOStuff.php.

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

◆ 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[]	$keys	List of keys
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array Map of (key => value) for existing keys; preserves the order of $keys

Reimplemented from MediumSpecificBagOStuff.

Definition at line 376 of file MemcachedPeclBagOStuff.php.

References $keys, $res, checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\stripRouteFromKey(), and MemcachedBagOStuff\validateKeyAndPrependRoute().

◆ doIncrWithInitAsync()

MemcachedPeclBagOStuff::doIncrWithInitAsync	(	$key,
		$exptime,
		$step,
		$init )

protected

Parameters

string	$key
int	$exptime
int	$step
int	$init

Returns: bool True on success, false on failure

Reimplemented from MemcachedBagOStuff.

Definition at line 281 of file MemcachedPeclBagOStuff.php.

References BagOStuff\$lastError, checkResult(), MediumSpecificBagOStuff\debug(), BagOStuff\getLastError(), MemcachedBagOStuff\validateKeyAndPrependRoute(), and BagOStuff\watchErrors().

◆ doIncrWithInitSync()

MemcachedPeclBagOStuff::doIncrWithInitSync	(	$key,
		$exptime,
		$step,
		$init )

protected

Parameters

string	$key
int	$exptime
int	$step
int	$init

Returns: int|bool New value or false on failure

Reimplemented from MemcachedBagOStuff.

Definition at line 293 of file MemcachedPeclBagOStuff.php.

References checkResult(), MediumSpecificBagOStuff\debug(), MemcachedBagOStuff\fixExpiry(), BagOStuff\getLastError(), MemcachedBagOStuff\validateKeyAndPrependRoute(), and BagOStuff\watchErrors().

◆ doSet()

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

protected

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 202 of file MemcachedPeclBagOStuff.php.

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

◆ doSetMulti()

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

protected

Parameters

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

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 402 of file MemcachedPeclBagOStuff.php.

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

◆ incr()

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

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

Parameters

string	$key	Key to increase
int	$value	Value to add to $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Deprecated: Since 1.38

Reimplemented from BagOStuff.

Definition at line 259 of file MemcachedPeclBagOStuff.php.

References checkResult(), MediumSpecificBagOStuff\debug(), and MemcachedBagOStuff\validateKeyAndPrependRoute().

◆ serialize()

MemcachedPeclBagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int|false String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented from MediumSpecificBagOStuff.

Definition at line 454 of file MemcachedPeclBagOStuff.php.

References serialize().

◆ setNewPreparedValues()

MemcachedPeclBagOStuff::setNewPreparedValues ( array $valueByKey )

Stage a set of new key values for storage and estimate the amount of bytes needed.

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, such as cache wrappers with adaptive write slam avoidance or store wrappers with metrics. 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 $valueByKey Map 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 313 of file MemcachedPeclBagOStuff.php.

References MediumSpecificBagOStuff\guessSerialSizeOfValues().

◆ unserialize()

MemcachedPeclBagOStuff::unserialize ( $value )

protected

Parameters

string | int | false $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 469 of file MemcachedPeclBagOStuff.php.

References MediumSpecificBagOStuff\isInteger(), and unserialize().

Member Data Documentation

◆ $client

Memcached MemcachedPeclBagOStuff::$client

protected

Definition at line 33 of file MemcachedPeclBagOStuff.php.

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

includes/libs/objectcache/MemcachedPeclBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkResult()

◆ decr()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doDelete()

◆ doDeleteMulti()

◆ doGet()

◆ doGetMulti()

◆ doIncrWithInitAsync()

◆ doIncrWithInitSync()

◆ doSet()

◆ doSetMulti()

◆ incr()

◆ serialize()

◆ setNewPreparedValues()

◆ unserialize()

Member Data Documentation

◆ $client