JobQueueAggregatorRedis Class Reference

Class to handle tracking information about all queues using PhpRedis. More...

Inheritance diagram for JobQueueAggregatorRedis:

Collaboration diagram for JobQueueAggregatorRedis:

List of all members.

Protected Member Functions
	__construct (array $params)
	include:
	doGetAllReadyWikiQueues ()
	doNotifyQueueEmpty ($wiki, $type)
	doNotifyQueueNonEmpty ($wiki, $type)
	doPurge ()
	getConnection ()
	Get a connection to the server that handles all sub-queues for this queue.
	handleException (RedisConnRef $conn, $e)
Protected Attributes
RedisConnectionPool	$redisPool
	*
array	$servers
	List of Redis server addresses *.
Private Member Functions
	dencQueueName ($name)
	encQueueName ($type, $wiki)
	getReadyQueueKey ()

---

Detailed Description

Class to handle tracking information about all queues using PhpRedis.

Since:

1.21

Definition at line 31 of file JobQueueAggregatorRedis.php.

---

Constructor & Destructor Documentation

JobQueueAggregatorRedis::__construct

(

array $

params

)

[protected]

include:

• redisConfig : An array of parameters to RedisConnectionPool::__construct().
• redisServers : Array of server entries, the first being the primary and the others being fallback servers. Each entry is either 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.

  Parameters:

  array

  $params

Reimplemented from JobQueueAggregator.

Definition at line 46 of file JobQueueAggregatorRedis.php.

---

Member Function Documentation

JobQueueAggregatorRedis::dencQueueName

(

$

name

)

[private]

Parameters:

string

$name

Returns:

string

Definition at line 199 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::doGetAllReadyWikiQueues

(

)

[protected]

See also:

JobQueueAggregator::getAllReadyWikiQueues()

Reimplemented from JobQueueAggregator.

Definition at line 86 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::doNotifyQueueEmpty	(	$	wiki,
		$	type
	)		[protected]

See also:

JobQueueAggregator::notifyQueueEmpty()

Reimplemented from JobQueueAggregator.

Definition at line 54 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::doNotifyQueueNonEmpty	(	$	wiki,
		$	type
	)		[protected]

See also:

JobQueueAggregator::notifyQueueNonEmpty()

Reimplemented from JobQueueAggregator.

Definition at line 70 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::doPurge

(

)

[protected]

See also:

JobQueueAggregator::purge()

Reimplemented from JobQueueAggregator.

Definition at line 136 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::encQueueName	(	$	type,
		$	wiki
	)		[private]

Parameters:

string	$type
string	$wiki

Returns:

string

Definition at line 191 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::getConnection

(

)

[protected]

Get a connection to the server that handles all sub-queues for this queue.

Returns:

RedisConnRef|bool Returns false on failure

Exceptions:

MWException

Definition at line 158 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::getReadyQueueKey

(

)

[private]

Returns:

string

Definition at line 182 of file JobQueueAggregatorRedis.php.

JobQueueAggregatorRedis::handleException	(	RedisConnRef $	conn,
		$	e
	)		[protected]

Parameters:

RedisConnRef	$conn
RedisException	$e

Returns:

void

Definition at line 175 of file JobQueueAggregatorRedis.php.

---

Member Data Documentation

RedisConnectionPool JobQueueAggregatorRedis::$redisPool [protected]

*

Definition at line 32 of file JobQueueAggregatorRedis.php.

array JobQueueAggregatorRedis::$servers [protected]

List of Redis server addresses *.

Definition at line 34 of file JobQueueAggregatorRedis.php.

---

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

• includes/jobqueue/aggregator/JobQueueAggregatorRedis.php