Base class for memcached clients. More...

Inheritance diagram for MemcachedBagOStuff:

[legend]

Collaboration diagram for MemcachedBagOStuff:

[legend]

Public Member Functions
	__construct (array $params)
	$params include:

	add ( $key, $value, $exptime=0)

	changeTTL ( $key, $exptime=0)
	Reset the TTL on a key if it exists.

	delete ( $key)
	Delete an item.

	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.

	getClient ()
	Get the underlying client object.

	makeKeyInternal ( $keyspace, $args)
	Construct a cache key.

	merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one)

	modifySimpleRelayEvent (array $event)
	Modify a cache update operation array for EventRelayer::notify()

	set ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	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 BagOStuff
	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	clearLastError ()
	Clear the "last error" registry.

	decr ( $key, $value=1)
	Decrease stored value of $key by $value while preserving its TTL.

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete all objects expiring before a certain date.

	get ( $key, $flags=0, $oldFlags=null)
	Get an item with the given key.

	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually.

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

	getQoS ( $flag)

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

	getWithSetCallback ( $key, $ttl, $callback, $flags=0)
	Get an item with the given key, regenerating and setting it if not found.

	incr ( $key, $value=1)
	Increase stored value of $key by $value while preserving its TTL.

	incrWithInit ( $key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL.

	lock ( $key, $timeout=6, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string.

	makeGlobalKey ()
	Make a global cache key.

	makeKey ()
	Make a cache key, scoped to this instance's keyspace.

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMulti (array $data, $exptime=0)
	Batch insertion.

	unlock ( $key)
	Release an advisory lock on a key string.

Protected Member Functions
	applyDefaultParams ( $params)
	Fill in some defaults for missing keys in $params.

	cas ( $casToken, $key, $value, $exptime=0)
	Check and set an item.

	debugLog ( $text)
	Send a debug message to the log.

	doGet ( $key, $flags=0)

	getWithToken ( $key, &$casToken, $flags=0)

Protected Member Functions inherited from BagOStuff
	convertExpiry ( $exptime)
	Convert an optionally relative time to an absolute time.

	convertToRelative ( $exptime)
	Convert an optionally absolute expiry time to a relative time.

	debug ( $text)

	isInteger ( $value)
	Check if a value is an integer.

	mergeFlagMaps (array $bags)
	Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

	mergeViaCas ( $key, $callback, $exptime=0, $attempts=10)

	mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0)

	setLastError ( $err)
	Set the "last error" registry.

Protected Attributes
MemcachedClient Memcached	$client

Protected Attributes inherited from BagOStuff
callback null	$asyncHandler

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

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

int	$lastError = self::ERR_NONE
	ERR_* class constant.

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

int	$syncTimeout
	Seconds.

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0
	Possible values for getLastError()

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

const	WRITE_SYNC = 1
	Bitfield constants for set()/merge()

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 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_WEEK = 604800

const	TTL_YEAR = 31536000

Detailed Description

Base class for memcached clients.

Definition at line 29 of file MemcachedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedBagOStuff::__construct ( array $params )

$params include:

logger: Psr\Log\LoggerInterface instance
keyspace: Default keyspace for $this->makeKey()
asyncHandler: Callable to use for scheduling tasks after the web request ends. In CLI mode, it should run the task immediately.
reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
syncTimeout: How long to wait with WRITE_SYNC in seconds.
Parameters

array $params

Reimplemented from BagOStuff.

Definition at line 33 of file MemcachedBagOStuff.php.

References $params, IExpiringStore\ATTR_SYNCWRITES, and IExpiringStore\QOS_SYNCWRITES_BE.

Member Function Documentation

◆ add()

MemcachedBagOStuff::add	(	$key,
		$value,
		$exptime = 0 )

Parameters

string	$key
mixed	$value
int	$exptime

Returns: bool Success

Reimplemented from BagOStuff.

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 77 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

◆ applyDefaultParams()

MemcachedBagOStuff::applyDefaultParams ( $params )

protected

Fill in some defaults for missing keys in $params.

Parameters

array $params

Returns: array

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 45 of file MemcachedBagOStuff.php.

References $params, and false.

Referenced by MemcachedPhpBagOStuff\__construct().

◆ cas()

MemcachedBagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = 0 )

protected

Check and set an item.

Parameters

mixed	$casToken
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry

Returns: bool Success

Exceptions

Exception

Reimplemented from BagOStuff.

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 68 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

◆ changeTTL()

MemcachedBagOStuff::changeTTL	(		$key,
			$expiry = 0 )

Reset the TTL on a key if it exists.

Parameters

string	$key
int	$expiry

Returns: bool Success Returns false if there is no key

Since: 1.28

Reimplemented from BagOStuff.

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 86 of file MemcachedBagOStuff.php.

References fixExpiry(), and validateKeyEncoding().

◆ debugLog()

MemcachedBagOStuff::debugLog ( $text )

protected

Send a debug message to the log.

Parameters

string $text

Definition at line 181 of file MemcachedBagOStuff.php.

Referenced by MemcachedPeclBagOStuff\add(), MemcachedPeclBagOStuff\cas(), MemcachedPeclBagOStuff\changeTTL(), MemcachedPeclBagOStuff\checkResult(), MemcachedPeclBagOStuff\decr(), MemcachedPeclBagOStuff\delete(), MemcachedPeclBagOStuff\getMulti(), MemcachedPeclBagOStuff\getWithToken(), MemcachedPeclBagOStuff\incr(), MemcachedPeclBagOStuff\set(), and MemcachedPeclBagOStuff\setMulti().

◆ delete()

MemcachedBagOStuff::delete ( $key )

Delete an item.

Parameters

string $key

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

Reimplemented from BagOStuff.

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 73 of file MemcachedBagOStuff.php.

References validateKeyEncoding().

◆ doGet()

MemcachedBagOStuff::doGet	(		$key,
			$flags = 0 )

protected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

Returns: mixed Returns false on failure and if the item does not exist

Reimplemented from BagOStuff.

Definition at line 53 of file MemcachedBagOStuff.php.

References $flags, and getWithToken().

◆ 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 170 of file MemcachedBagOStuff.php.

Referenced by add(), cas(), changeTTL(), set(), and MemcachedPeclBagOStuff\setMulti().

◆ getClient()

MemcachedBagOStuff::getClient ( )

Get the underlying client object.

This is provided for debugging purposes.

Returns: MemcachedClient|Memcached

Definition at line 96 of file MemcachedBagOStuff.php.

References $client.

◆ getWithToken()

MemcachedBagOStuff::getWithToken	(		$key,
		&	$casToken,
			$flags = 0 )

protected

Note: : This method is only needed if merge() uses mergeViaCas()

Parameters

string	$key
mixed	&$casToken
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

Returns: mixed Returns false on failure and if the item does not exist

Exceptions

Exception

Reimplemented from BagOStuff.

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 59 of file MemcachedBagOStuff.php.

References validateKeyEncoding().

Referenced by doGet().

◆ makeKeyInternal()

MemcachedBagOStuff::makeKeyInternal	(		$keyspace,
			$args )

Construct a cache key.

Since: 1.27

Parameters

string	$keyspace
array	$args

Returns: string

Reimplemented from BagOStuff.

Definition at line 108 of file MemcachedBagOStuff.php.

References $args, and BagOStuff\$keyspace.

◆ merge()

MemcachedBagOStuff::merge	(		$key,
		callable	$callback,
			$exptime = 0,
			$attempts = 10,
			$flags = 0 )

Merge changes into the existing cache value (possibly creating a new one)

The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overriden in the callback.

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Exceptions

InvalidArgumentException

Reimplemented from BagOStuff.

Definition at line 82 of file MemcachedBagOStuff.php.

References BagOStuff\mergeViaCas().

◆ modifySimpleRelayEvent()

MemcachedBagOStuff::modifySimpleRelayEvent ( array $event )

Modify a cache update operation array for EventRelayer::notify()

This is used for relayed writes, e.g. for broadcasting a change to multiple data-centers. If the array contains a 'val' field then the command involves setting a key to that value. Note that for simplicity, 'val' is always a simple scalar value. This method is used to possibly serialize the value and add any cache-specific key/values needed for the relayer daemon (e.g. memcached flags).

Parameters

array $event

Returns: array

Since: 1.26

Reimplemented from BagOStuff.

Definition at line 185 of file MemcachedBagOStuff.php.

◆ set()

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

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 63 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

◆ 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 154 of file MemcachedBagOStuff.php.

Referenced by add(), cas(), changeTTL(), MemcachedPhpBagOStuff\decr(), delete(), MemcachedPeclBagOStuff\getMulti(), MemcachedPhpBagOStuff\getMulti(), getWithToken(), MemcachedPeclBagOStuff\getWithToken(), MemcachedPhpBagOStuff\incr(), set(), and MemcachedPeclBagOStuff\setMulti().

Member Data Documentation

◆ $client

MemcachedClient Memcached MemcachedBagOStuff::$client

protected

Definition at line 31 of file MemcachedBagOStuff.php.

Referenced by getClient().

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

includes/libs/objectcache/MemcachedBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ applyDefaultParams()

◆ cas()

◆ changeTTL()

◆ debugLog()

◆ delete()

◆ doGet()

◆ fixExpiry()

◆ getClient()

◆ getWithToken()

◆ makeKeyInternal()

◆ merge()

◆ modifySimpleRelayEvent()

◆ set()

◆ validateKeyEncoding()

Member Data Documentation

◆ $client