WinCacheBagOStuff Class Reference

Wrapper for WinCache object caching functions; identical interface to the APC wrapper. More...

Inheritance diagram for WinCacheBagOStuff:

Collaboration diagram for WinCacheBagOStuff:

Public Member Functions
	__construct (array $params=[])
	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.
	makeKeyInternal ( $keyspace, $components)
	Make a cache key for the given keyspace and components.
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.
	clearLastError ()
	Clear the "last error" registry.
	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.
	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)
	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.
	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.
	setNewPreparedValues (array $valueByKey)
	Make a "generic" reversible cache key from the given components.
	unlock ( $key)
	Release an advisory lock on a key string.
Public Member Functions inherited from BagOStuff
	getCurrentTime ()
	getLogger ()
	getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.
	getWithSetCallback ( $key, $exptime, $callback, $flags=0)
	Get an item with the given key, 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.
	setDebug ( $enabled)
	setLogger (LoggerInterface $logger)
	setMockTime (&$time)

Protected Member Functions
	doAdd ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.
	doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.
	doDelete ( $key, $flags=0)
	Delete an item.
	doGet ( $key, $flags=0, &$casToken=null)
	doSet ( $key, $value, $exptime=0, $flags=0)
	Set an item.
Protected Member Functions inherited from MediumSpecificBagOStuff
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.
	convertGenericKey ( $key)
	Convert a "generic" reversible cache key into one for this cache.
	debug ( $text)
	doChangeTTL ( $key, $exptime, $flags)
	doChangeTTLMulti (array $keys, $exptime, $flags=0)
	doDeleteMulti (array $keys, $flags=0)
	doGetMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.
	doLock ( $key, $timeout, $exptime)
	doSetMulti (array $data, $exptime=0, $flags=0)
	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.
	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)
	Determine the entry (inline or segment list) to store under a key to save the value.
	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)
	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key.
	serialize ( $value)
	setLastError ( $err)
	Set the "last error" registry.
	unserialize ( $value)
	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 ( $method, $arg0Sig, $resSig, array $genericArgs)
	Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys.

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.
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.
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 response.
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.
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")
Protected Attributes inherited from MediumSpecificBagOStuff
callable[]	$busyCallbacks = []
int	$lastError = self::ERR_NONE
	ERR_* class constant.
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.
int	$syncTimeout
	Seconds.
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'
Protected Attributes inherited from BagOStuff
callable null	$asyncHandler
int[]	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant)
bool	$debugMode = true
	Whether to send debug log entries to the SPI logger instance.
string	$keyspace
	Default keyspace; used by makeKey()
LoggerInterface	$logger
StatsdDataFactoryInterface	$stats
array< string, array >	$wrapperInfoByPrefix = []
	Cache key processing callbacks and info for metrics.

Detailed Description

Wrapper for WinCache object caching functions; identical interface to the APC wrapper.

Definition at line 30 of file WinCacheBagOStuff.php.

Constructor & Destructor Documentation

__construct()

WinCacheBagOStuff::__construct

(

array

$params = []

)

See also

BagOStuff::__construct() Additional $params options include:

• logger: Psr\Log\LoggerInterface instance
• 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.
• segmentationSize: The chunk size, in bytes, of segmented values. The value should not exceed the maximum size of values in the storage backend, as configured by the site administrator.
• segmentedValueMaxSize: The maximum total size, in bytes, of segmented values. This should be configured to a reasonable size give the site traffic and the amount of I/O between application and cache servers that the network can handle.

Parameters

array

$params

@phpcs:ignore Generic.Files.LineLength

Reimplemented from MediumSpecificBagOStuff.

Definition at line 31 of file WinCacheBagOStuff.php.

References Wikimedia\LightweightObjectStore\StorageAwareness\ATTR_DURABILITY, Wikimedia\LightweightObjectStore\StorageAwareness\QOS_DURABILITY_NONE, Wikimedia\LightweightObjectStore\StorageAwareness\QOS_DURABILITY_SCRIPT, and Wikimedia\LightweightObjectStore\StorageAwareness\QOS_DURABILITY_SERVICE.

Member Function Documentation

decr()

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

Reimplemented from BagOStuff.

Definition at line 161 of file WinCacheBagOStuff.php.

References incr().

doAdd()

WinCacheBagOStuff::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 94 of file WinCacheBagOStuff.php.

References MediumSpecificBagOStuff\getExpirationAsTTL(), and MediumSpecificBagOStuff\getSerialized().

doCas()

WinCacheBagOStuff::doCas (   $casToken,   $key,   $value,   $exptime = 0,   $flags = 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
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns

bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 61 of file WinCacheBagOStuff.php.

References $success, and doGet().

doDelete()

WinCacheBagOStuff::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 108 of file WinCacheBagOStuff.php.

doGet()

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

protected

Parameters

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

References $blob, and MediumSpecificBagOStuff\unserialize().

Referenced by doCas(), and incr().

doSet()

WinCacheBagOStuff::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 84 of file WinCacheBagOStuff.php.

References MediumSpecificBagOStuff\getExpirationAsTTL(), and MediumSpecificBagOStuff\getSerialized().

incr()

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

Reimplemented from BagOStuff.

Definition at line 142 of file WinCacheBagOStuff.php.

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

Referenced by decr().

makeKeyInternal()

WinCacheBagOStuff::makeKeyInternal	(		$keyspace,
			$components
	)

Make a cache key for the given keyspace and components.

Long components might be converted to respective hashes due to size constraints. In extreme cases, all of them might be combined into a single hash component.

Access: internal

This method should not be used outside of BagOStuff (since 1.36)

Parameters

string	$keyspace	Keyspace component
string[] | int[]	$components	Key components (key collection name first)

Returns

string Keyspace-prepended list of encoded components as a colon-separated value

Since

1.27

Reimplemented from BagOStuff.

Definition at line 114 of file WinCacheBagOStuff.php.

References BagOStuff\$keyspace.

---

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

• includes/libs/objectcache/WinCacheBagOStuff.php