Interface to key-value storage behind an HTTP server. More...

Inheritance diagram for RESTBagOStuff:

[legend]

Collaboration diagram for RESTBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)

	add ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

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

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

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

	setLogger (LoggerInterface $logger)

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	$params include:

	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	changeTTL ( $key, $expiry=0, $flags=0)
	Change the expiration on a key if it exists.

	clearLastError ()
	Clear the "last error" registry.

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

	deleteMulti (array $keys, $flags=0)
	Batch deletion.

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	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)

	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.

	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 ( $class, $component=null)
	Make a global cache key.

	makeKey ( $class, $component=null)
	Make a cache key, scoped to this instance's keyspace.

	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)

	setDebug ( $bool)

	setMockTime (&$time)

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

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

Public Attributes
const	DEFAULT_CONN_TIMEOUT = 1.2
	Default connection timeout in seconds.

const	DEFAULT_REQ_TIMEOUT = 3.0
	Default request timeout.

Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

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

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 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_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Member Functions
	doGet ( $key, $flags=0, &$casToken=null)

	handleError ( $msg, $rcode, $rerr)
	Handle storage error.

Protected Member Functions inherited from BagOStuff
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.

	convertToExpiry ( $exptime)
	Convert an optionally relative time to an absolute time.

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

	debug ( $text)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

	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, $flags=0)

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

Private Attributes
MultiHttpClient	$client

string	$url
	REST URL to use for storage.

Additional Inherited Members
Protected Attributes inherited from BagOStuff
callable 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.

Detailed Description

Interface to key-value storage behind an HTTP server.

Uses URL of the form "baseURL/{KEY}" to store, fetch, and delete values.

E.g., when base URL is /v1/sessions/, then the store would do:

PUT /v1/sessions/12345758

and fetch would do:

GET /v1/sessions/12345758

delete would do:

DELETE /v1/sessions/12345758

Configure with:

$wgObjectCaches['sessions'] = array(
 'class' => 'RESTBagOStuff',
 'url' => 'http://localhost:7231/wikimedia.org/v1/sessions/'
);

Definition at line 31 of file RESTBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

RESTBagOStuff::__construct ( $params )

Definition at line 55 of file RESTBagOStuff.php.

References $params, and(), IExpiringStore\ATTR_SYNCWRITES, DEFAULT_CONN_TIMEOUT, DEFAULT_REQ_TIMEOUT, and IExpiringStore\QOS_SYNCWRITES_QC.

Member Function Documentation

◆ add()

RESTBagOStuff::add	(	$key,
		$value,
		$exptime = 0,
		$flags = 0 )

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

Definition at line 127 of file RESTBagOStuff.php.

References $value, and and().

◆ delete()

RESTBagOStuff::delete	(		$key,
			$flags = 0 )

Delete an item.

Parameters

string $key

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

Parameters

int $flags Bitfield of BagOStuff::WRITE_* constants

Reimplemented from BagOStuff.

Definition at line 136 of file RESTBagOStuff.php.

References $req, and(), handleError(), and list.

◆ doGet()

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

protected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	Token to use for check-and-set comparisons

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

Reimplemented from BagOStuff.

Definition at line 87 of file RESTBagOStuff.php.

References $req, $value, and(), false, handleError(), list, and unserialize().

◆ handleError()

RESTBagOStuff::handleError	(	$msg,
		$rcode,
		$rerr )

protected

Handle storage error.

Parameters

string	$msg	Error message
int	$rcode	Error code from client
string	$rerr	Error message from client

Returns: false

Definition at line 168 of file RESTBagOStuff.php.

References IExpiringStore\ERR_UNEXPECTED, and BagOStuff\setLastError().

Referenced by delete(), doGet(), and set().

◆ incr()

RESTBagOStuff::incr	(		$key,
			$value = 1 )

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]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 149 of file RESTBagOStuff.php.

References $value, and(), BagOStuff\isInteger(), and BagOStuff\READ_LATEST.

◆ set()

RESTBagOStuff::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.

Definition at line 112 of file RESTBagOStuff.php.

References $req, $value, and(), handleError(), list, and serialize().

◆ setLogger()

RESTBagOStuff::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Returns: void

Reimplemented from BagOStuff.

Definition at line 82 of file RESTBagOStuff.php.

References BagOStuff\$logger.

Member Data Documentation

◆ $client

MultiHttpClient RESTBagOStuff::$client

private

Definition at line 47 of file RESTBagOStuff.php.

◆ $url

string RESTBagOStuff::$url

private

REST URL to use for storage.

Definition at line 53 of file RESTBagOStuff.php.

◆ DEFAULT_CONN_TIMEOUT

const RESTBagOStuff::DEFAULT_CONN_TIMEOUT = 1.2

Default connection timeout in seconds.

The kernel retransmits the SYN packet after 1 second, so 1.2 seconds allows for 1 retransmit without permanent failure.

Definition at line 37 of file RESTBagOStuff.php.

Referenced by __construct().

◆ DEFAULT_REQ_TIMEOUT

const RESTBagOStuff::DEFAULT_REQ_TIMEOUT = 3.0

Default request timeout.

Definition at line 42 of file RESTBagOStuff.php.

Referenced by __construct().

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

includes/libs/objectcache/RESTBagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ delete()

◆ doGet()

◆ handleError()

◆ incr()

◆ set()

◆ setLogger()

Member Data Documentation

◆ $client

◆ $url

◆ DEFAULT_CONN_TIMEOUT

◆ DEFAULT_REQ_TIMEOUT