MediaWiki  master
Wikimedia\LightweightObjectStore\StorageAwareness Interface Reference

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

Inheritance diagram for Wikimedia\LightweightObjectStore\StorageAwareness:

Public Attributes

const ATTR_DURABILITY = 2
 Durability of writes; see QOS_DURABILITY_* (higher means stronger) More...
 
const ATTR_EMULATION = 1
 Emulation/fallback mode; see QOS_EMULATION_*; higher is better. More...
 
const ERR_NO_RESPONSE = 1
 Storage medium failed to yield a response. More...
 
const ERR_NONE = 0
 No storage medium error. More...
 
const ERR_UNEXPECTED = 3
 Storage medium operation failed due to usage limitations or an I/O error. More...
 
const ERR_UNREACHABLE = 2
 Storage medium could not be reached. More...
 
const QOS_DURABILITY_DISK = 4
 Data is saved to disk and writes do not usually block on fsync() More...
 
const QOS_DURABILITY_NONE = 1
 Data is never saved to begin with (blackhole store) More...
 
const QOS_DURABILITY_RDBMS = 5
 Data is saved to disk and writes usually block on fsync(), like a standard RDBMS. More...
 
const QOS_DURABILITY_SCRIPT = 2
 Data is lost at the end of the current web request or CLI script. More...
 
const QOS_DURABILITY_SERVICE = 3
 Data is lost once the service storing the data restarts. More...
 
const QOS_EMULATION_SQL = 1
 Fallback disk-based SQL store. More...
 
const QOS_UNKNOWN = INF
 Generic "unknown" value; useful for comparisons (always "good enough") More...
 

Detailed Description

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

Since
1.35

Definition at line 32 of file StorageAwareness.php.

Member Data Documentation

◆ ATTR_DURABILITY

const Wikimedia\LightweightObjectStore\StorageAwareness::ATTR_DURABILITY = 2

◆ ATTR_EMULATION

const Wikimedia\LightweightObjectStore\StorageAwareness::ATTR_EMULATION = 1

Emulation/fallback mode; see QOS_EMULATION_*; higher is better.

Definition at line 43 of file StorageAwareness.php.

Referenced by SqlBagOStuff\__construct().

◆ ERR_NO_RESPONSE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_NO_RESPONSE = 1

Storage medium failed to yield a response.

Definition at line 36 of file StorageAwareness.php.

Referenced by WANObjectCache\getLastError().

◆ ERR_NONE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_NONE = 0

No storage medium error.

Definition at line 34 of file StorageAwareness.php.

Referenced by MultiWriteBagOStuff\getLastError(), and 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 40 of file StorageAwareness.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), WANObjectCache\getLastError(), and RedisBagOStuff\handleException().

◆ ERR_UNREACHABLE

const Wikimedia\LightweightObjectStore\StorageAwareness::ERR_UNREACHABLE = 2

Storage medium could not be reached.

Definition at line 38 of file StorageAwareness.php.

Referenced by RedisBagOStuff\getConnection(), and 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 57 of file StorageAwareness.php.

Referenced by RedisBagOStuff\__construct(), and 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 51 of file StorageAwareness.php.

Referenced by APCUBagOStuff\__construct(), EmptyBagOStuff\__construct(), and WinCacheBagOStuff\__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 59 of file StorageAwareness.php.

Referenced by SqlBagOStuff\__construct().

◆ 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 53 of file StorageAwareness.php.

Referenced by HashBagOStuff\__construct(), APCUBagOStuff\__construct(), and WinCacheBagOStuff\__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 55 of file StorageAwareness.php.

Referenced by MemcachedBagOStuff\__construct(), APCUBagOStuff\__construct(), and WinCacheBagOStuff\__construct().

◆ QOS_EMULATION_SQL

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_EMULATION_SQL = 1

Fallback disk-based SQL store.

Definition at line 48 of file StorageAwareness.php.

Referenced by SqlBagOStuff\__construct().

◆ QOS_UNKNOWN

const Wikimedia\LightweightObjectStore\StorageAwareness::QOS_UNKNOWN = INF

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

Definition at line 62 of file StorageAwareness.php.

Referenced by BagOStuff\getQoS().


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