MediaWiki  1.28.0
RESTBagOStuff Class Reference

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

Inheritance diagram for RESTBagOStuff:
Collaboration diagram for RESTBagOStuff:

Public Member Functions

 __construct ($params)
 
 delete ($key)
 Delete an item. More...
 
 set ($key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 $params include: More...
 
 add ($key, $value, $exptime=0)
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ($key, $expiry=0)
 Reset the TTL on a key if it exists. More...
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 decr ($key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 delete ($key)
 Delete an item. More...
 
 deleteObjectsExpiringBefore ($date, $progressCallback=false)
 Delete all objects expiring before a certain date. More...
 
 get ($key, $flags=0, $oldFlags=null)
 Get an item with the given key. More...
 
 getLastError ()
 Get the "last error" registered; clearLastError() should be called manually. More...
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 getQoS ($flag)
 
 getScopedLock ($key, $timeout=6, $expiry=30, $rclass= '')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getWithSetCallback ($key, $ttl, $callback, $flags=0)
 Get an item with the given key, regenerating and setting it if not found. More...
 
 incr ($key, $value=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 incrWithInit ($key, $ttl, $value=1, $init=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 lock ($key, $timeout=6, $expiry=6, $rclass= '')
 Acquire an advisory lock on a key string. More...
 
 makeGlobalKey ()
 Make a global cache key. More...
 
 makeKey ()
 Make a cache key, scoped to this instance's keyspace. More...
 
 makeKeyInternal ($keyspace, $args)
 Construct a cache key. More...
 
 merge ($key, callable $callback, $exptime=0, $attempts=10, $flags=0)
 Merge changes into the existing cache value (possibly creating a new one) More...
 
 modifySimpleRelayEvent (array $event)
 Modify a cache update operation array for EventRelayer::notify() More...
 
 set ($key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setDebug ($bool)
 
 setLogger (LoggerInterface $logger)
 
 setMulti (array $data, $exptime=0)
 Batch insertion. More...
 
 unlock ($key)
 Release an advisory lock on a key string. More...
 

Protected Member Functions

 doGet ($key, $flags=0)
 
 handleError ($msg, $rcode, $rerr)
 Handle storage error. More...
 
- Protected Member Functions inherited from BagOStuff
 cas ($casToken, $key, $value, $exptime=0)
 Check and set an item. More...
 
 convertExpiry ($exptime)
 Convert an optionally relative time to an absolute time. More...
 
 convertToRelative ($exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ($text)
 
 doGet ($key, $flags=0)
 
 getWithToken ($key, &$casToken, $flags=0)
 
 isInteger ($value)
 Check if a value is an integer. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 mergeViaCas ($key, $callback, $exptime=0, $attempts=10)
 
 mergeViaLock ($key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ($err)
 Set the "last error" registry. More...
 

Private Attributes

MultiHttpClient $client
 
string $url
 REST URL to use for storage. More...
 

Additional Inherited Members

- Public Attributes inherited from BagOStuff
const ERR_NO_RESPONSE = 1
 
const ERR_NONE = 0
 Possible values for getLastError() More...
 
const ERR_UNEXPECTED = 3
 
const ERR_UNREACHABLE = 2
 
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_CACHE_ONLY = 2
 
const WRITE_SYNC = 1
 Bitfield constants for set()/merge() More...
 
- 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
 
- Protected Attributes inherited from BagOStuff
callback null $asyncHandler
 
integer[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
callable[] $busyCallbacks = []
 
string $keyspace = 'local'
 
integer $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array[] $locks = []
 Lock tracking. More...
 
LoggerInterface $logger
 
integer $syncTimeout
 Seconds. More...
 

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 29 of file RESTBagOStuff.php.

Constructor & Destructor Documentation

RESTBagOStuff::__construct (   $params)

Definition at line 42 of file RESTBagOStuff.php.

References $params.

Member Function Documentation

RESTBagOStuff::delete (   $key)

Delete an item.

Parameters
string$key
Returns
bool True if the item was deleted or not found, false on failure

Definition at line 126 of file RESTBagOStuff.php.

References $req, handleError(), and list.

RESTBagOStuff::doGet (   $key,
  $flags = 0 
)
protected
Parameters
string$key
integer$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist

Definition at line 63 of file RESTBagOStuff.php.

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

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

Handle storage error.

Parameters
string$msgError message
int$rcodeError code from client
string$rerrError message from client
Returns
false

Definition at line 89 of file RESTBagOStuff.php.

References BagOStuff\setLastError().

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

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

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Definition at line 107 of file RESTBagOStuff.php.

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

Member Data Documentation

MultiHttpClient RESTBagOStuff::$client
private

Definition at line 34 of file RESTBagOStuff.php.

string RESTBagOStuff::$url
private

REST URL to use for storage.

Definition at line 40 of file RESTBagOStuff.php.


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