Generic interface providing error code and quality-of-service constants for object stores. More...

Inherited by MemcachedClient, Wikimedia\ObjectCache\BagOStuff, and Wikimedia\ObjectCache\WANObjectCache.

Public Attributes
const	ATTR_DURABILITY = 2
	Durability of writes; see QOS_DURABILITY_* (higher means stronger)

const	ATTR_EMULATION = 1

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_UNKNOWN = INF
	Generic "unknown" value; useful for comparisons (always "good enough")

Detailed Description

Generic interface providing error code and quality-of-service constants for object stores.

Access: internal: For use by BagOStuff and WANObjectCache

Definition at line 29 of file StorageAwareness.php.

Member Data Documentation

◆ ATTR_DURABILITY

const Wikimedia\LightweightObjectStore\StorageAwareness::ATTR_DURABILITY = 2

Durability of writes; see QOS_DURABILITY_* (higher means stronger)

Definition at line 42 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\__construct(), Wikimedia\ObjectCache\RESTBagOStuff\__construct(), Wikimedia\ObjectCache\HashBagOStuff\__construct(), Wikimedia\ObjectCache\MemcachedBagOStuff\__construct(), Wikimedia\ObjectCache\APCUBagOStuff\__construct(), and Wikimedia\ObjectCache\EmptyBagOStuff\__construct().

◆ ATTR_EMULATION

const Wikimedia\LightweightObjectStore\StorageAwareness::ATTR_EMULATION = 1

Deprecated: Since 1.41; Emulation/fallback mode; see QOS_EMULATION_*; higher is better

Definition at line 40 of file StorageAwareness.php.

◆ ERR_NO_RESPONSE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_NO_RESPONSE = 1

Storage medium failed to yield a complete response to an operation.

Definition at line 33 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\MemcachedPeclBagOStuff\checkResult(), and Wikimedia\ObjectCache\WANObjectCache\getLastError().

◆ ERR_NONE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_NONE = 0

No storage medium error.

Definition at line 31 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\WANObjectCache\getLastError().

◆ ERR_UNEXPECTED

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_UNEXPECTED = 3

Storage medium operation failed due to usage limitations or an I/O error.

Definition at line 37 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\WANObjectCache\getLastError(), Wikimedia\ObjectCache\RESTBagOStuff\handleError(), and Wikimedia\ObjectCache\RedisBagOStuff\handleException().

◆ ERR_UNREACHABLE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_UNREACHABLE = 2

Storage medium could not be reached to establish a connection.

Definition at line 35 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\MemcachedPeclBagOStuff\checkResult(), Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys(), and Wikimedia\ObjectCache\WANObjectCache\getLastError().

◆ QOS_DURABILITY_DISK

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_DURABILITY_DISK = 4

Data is saved to disk and writes do not usually block on fsync()

Definition at line 51 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\RedisBagOStuff\__construct(), and Wikimedia\ObjectCache\RESTBagOStuff\__construct().

◆ QOS_DURABILITY_NONE

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_DURABILITY_NONE = 1

Data is never saved to begin with (blackhole store)

Definition at line 45 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\APCUBagOStuff\__construct(), and Wikimedia\ObjectCache\EmptyBagOStuff\__construct().

◆ QOS_DURABILITY_RDBMS

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_DURABILITY_RDBMS = 5

Data is saved to disk and writes usually block on fsync(), like a standard RDBMS.

Definition at line 53 of file StorageAwareness.php.

◆ QOS_DURABILITY_SCRIPT

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_DURABILITY_SCRIPT = 2

Data is lost at the end of the current web request or CLI script.

Definition at line 47 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\HashBagOStuff\__construct(), and Wikimedia\ObjectCache\APCUBagOStuff\__construct().

◆ QOS_DURABILITY_SERVICE

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_DURABILITY_SERVICE = 3

Data is lost once the service storing the data restarts.

Definition at line 49 of file StorageAwareness.php.

Referenced by Wikimedia\ObjectCache\MemcachedBagOStuff\__construct(), and Wikimedia\ObjectCache\APCUBagOStuff\__construct().

◆ QOS_UNKNOWN

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_UNKNOWN = INF

Generic "unknown" value; useful for comparisons (always "good enough")

Definition at line 56 of file StorageAwareness.php.

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

includes/libs/objectcache/utils/StorageAwareness.php

Public Attributes