Inheritance diagram for RedisBagOStuff:

Collaboration diagram for RedisBagOStuff:

Public Member Functions
	__construct ($params)
	Construct a RedisBagOStuff object.
	add ($key, $value, $expiry=0)
	delete ($key, $time=0)
	Delete an item.
	get ($key)
	Get an item with the given key.
	getMulti (array $keys)
	Get an associative array containing the item for each of the keys that have items.
	incr ($key, $value=1)
	Non-atomic implementation of incr().
	logRequest ($method, $key, $server, $result)
	Send information about a single request to the debug log.
	replace ($key, $value, $expiry=0)
	Non-atomic implementation of replace().
	set ($key, $value, $expiry=0)
	Set an item.
Public Attributes
	$automaticFailover
	$password
	$persistent
Protected Member Functions
	getConnection ($key)
	Get a Redis object with a connection suitable for fetching the specified key.
	getConnectionToServer ($server)
	Get a connection to the server with the specified name.
	handleException ($server, $e)
	The redis extension throws an exception in response to various read, write and protocol errors.
	logError ($msg)
	Log a fatal error.
Protected Attributes
	$connectTimeout
	$conns = array()
	A cache of Redis objects, representing connections to Redis servers.
	$deadServers = array()
	An array listing "dead" servers which have had a connection error in the past.
	$servers
	A list of server names, from $params['servers'].

Detailed Description

Definition at line 24 of file RedisBagOStuff.php.

Constructor & Destructor Documentation

RedisBagOStuff::__construct ( $ params )

Construct a RedisBagOStuff object.

Parameters are:

servers: An array of server names. A server name may be a hostname, a hostname/port combination or the absolute path of a UNIX socket. If a hostname is specified but no port, the standard port number 6379 will be used. Required.

connectTimeout: The timeout for new connections, in seconds. Optional, default is 1 second.

persistent: Set this to true to allow connections to persist across multiple web requests. False by default.

password: The authentication password, will be sent to Redis in clear text. Optional, if it is unspecified, no AUTH command will be sent.

automaticFailover: If this is false, then each key will be mapped to a single server, and if that server is down, any requests for that key will fail. If this is true, a connection failure will cause the client to immediately try the next server in the list (as determined by a consistent hashing algorithm). True by default. This has the potential to create consistency issues if a server is slow enough to flap, for example if it is in swap death.

Definition at line 73 of file RedisBagOStuff.php.

References $params.

Member Function Documentation

RedisBagOStuff::add	(	$	key,
		$	value,
		$	exptime = `0`
	)

Parameters:

$key	string
$value	mixed
$exptime	integer

Returns:: bool success

Reimplemented from BagOStuff.

Definition at line 197 of file RedisBagOStuff.php.

References $result, $value, BagOStuff\convertToRelative(), getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::delete	(	$	key,
		$	time = `0`
	)

Delete an item.

Parameters:

$key	string
$time	int Amount of time to delay the operation (mostly memcached-specific)

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

Reimplemented from BagOStuff.

Definition at line 136 of file RedisBagOStuff.php.

References $result, getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::get ( $ key )

Get an item with the given key.

Returns false if it does not exist.

Parameters:

$key string

Returns:: mixed Returns false on failure

Reimplemented from BagOStuff.

Definition at line 93 of file RedisBagOStuff.php.

References $result, getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::getConnection ( $ key ) [protected]

Get a Redis object with a connection suitable for fetching the specified key.

Definition at line 287 of file RedisBagOStuff.php.

References $hashes, and getConnectionToServer().

Referenced by add(), delete(), get(), getMulti(), incr(), replace(), and set().

RedisBagOStuff::getConnectionToServer ( $ server ) [protected]

Get a connection to the server with the specified name.

Connections are cached, and failures are persistent to avoid multiple timeouts.

Returns:: Redis object, or false on failure

Definition at line 320 of file RedisBagOStuff.php.

References $result, BagOStuff\debug(), logError(), IP\splitHostAndPort(), and wfDebugLog().

Referenced by getConnection().

RedisBagOStuff::getMulti ( array $ keys )

Get an associative array containing the item for each of the keys that have items.

Parameters:

$keys Array List of strings

Returns:: Array

Reimplemented from BagOStuff.

Definition at line 156 of file RedisBagOStuff.php.

References $conns, $result, $value, BagOStuff\debug(), getConnection(), handleException(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::handleException	(	$	server,
		$	e
	)		`[protected]`

The redis extension throws an exception in response to various read, write and protocol errors.

Sometimes it also closes the connection, sometimes not. The safest response for us is to explicitly destroy the connection object and let it be reopened during the next request.

Definition at line 400 of file RedisBagOStuff.php.

References wfDebugLog().

Referenced by add(), delete(), get(), getMulti(), incr(), replace(), and set().

RedisBagOStuff::incr	(	$	key,
		$	value = `1`
	)

Non-atomic implementation of incr().

Probably all callers actually want incr() to atomically initialise values to zero if they don't exist, as provided by the Redis INCR command. But we are constrained by the memcached-like interface to return null in that case. Once the key exists, further increments are atomic.

Reimplemented from BagOStuff.

Definition at line 261 of file RedisBagOStuff.php.

References $result, $value, getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::logError ( $ msg ) [protected]

Log a fatal error.

Definition at line 390 of file RedisBagOStuff.php.

References wfDebugLog().

Referenced by getConnectionToServer().

RedisBagOStuff::logRequest	(	$	method,
		$	key,
		$	server,
		$	result
	)

Send information about a single request to the debug log.

Definition at line 408 of file RedisBagOStuff.php.

References $result, and BagOStuff\debug().

Referenced by add(), delete(), get(), incr(), replace(), and set().

RedisBagOStuff::replace	(	$	key,
		$	value,
		$	expiry = `0`
	)

Non-atomic implementation of replace().

Could perhaps be done atomically with WATCH or scripting, but this function is rarely used.

Reimplemented from BagOStuff.

Definition at line 223 of file RedisBagOStuff.php.

References $result, $value, BagOStuff\convertToRelative(), getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

RedisBagOStuff::set	(	$	key,
		$	value,
		$	exptime = `0`
	)

Set an item.

Parameters:

$key	string
$value	mixed
$exptime	int Either an interval in seconds or a unix timestamp for expiry

Returns:: bool success

Reimplemented from BagOStuff.

Definition at line 111 of file RedisBagOStuff.php.

References $result, $value, BagOStuff\convertToRelative(), getConnection(), handleException(), logRequest(), wfProfileIn(), and wfProfileOut().

Member Data Documentation

RedisBagOStuff::$automaticFailover

Definition at line 25 of file RedisBagOStuff.php.

RedisBagOStuff::$connectTimeout [protected]

Definition at line 25 of file RedisBagOStuff.php.

RedisBagOStuff::$conns = array() [protected]

A cache of Redis objects, representing connections to Redis servers.

The key is the server name.

Definition at line 36 of file RedisBagOStuff.php.

Referenced by getMulti().

RedisBagOStuff::$deadServers = array() [protected]

An array listing "dead" servers which have had a connection error in the past.

Servers are marked dead for a limited period of time, to avoid excessive overhead from repeated connection timeouts. The key in the array is the server name, the value is the UNIX timestamp at which the server is resurrected.

Definition at line 45 of file RedisBagOStuff.php.

RedisBagOStuff::$password

Definition at line 25 of file RedisBagOStuff.php.

RedisBagOStuff::$persistent

Definition at line 25 of file RedisBagOStuff.php.

RedisBagOStuff::$servers [protected]

A list of server names, from $params['servers'].

Definition at line 30 of file RedisBagOStuff.php.

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

includes/objectcache/RedisBagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation