JobQueueAggregator Class Reference

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

Inheritance diagram for JobQueueAggregator:

List of all members.

Public Member Functions
	getAllReadyWikiQueues ()
	Get the list of all of the queues with jobs.
	notifyQueueEmpty ($wiki, $type)
	Mark a queue as being empty.
	notifyQueueNonEmpty ($wiki, $type)
	Mark a queue as being non-empty.
	purge ()
	Purge all of the aggregator information.
Static Public Member Functions
static	destroySingleton ()
	Destroy the singleton instance.
static	singleton ()
Protected Member Functions
	__construct (array $params)
	doGetAllReadyWikiQueues ()
	doNotifyQueueEmpty ($wiki, $type)
	doNotifyQueueNonEmpty ($wiki, $type)
	doPurge ()
	findPendingWikiQueues ()
	Get all databases that have a pending job.
Static Protected Attributes
static	$instance = null

---

Detailed Description

Class to handle tracking information about all queues.

Since:

1.21

Definition at line 30 of file JobQueueAggregator.php.

---

Constructor & Destructor Documentation

JobQueueAggregator::__construct

(

array $

params

)

[protected]

Parameters:

array

$params

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Definition at line 37 of file JobQueueAggregator.php.

---

Member Function Documentation

static JobQueueAggregator::destroySingleton

(

)

[static, final]

Destroy the singleton instance.

Returns:

void

Definition at line 64 of file JobQueueAggregator.php.

JobQueueAggregator::doGetAllReadyWikiQueues

(

)

[abstract, protected]

See also:

JobQueueAggregator::getAllReadyWikiQueues()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by getAllReadyWikiQueues().

JobQueueAggregator::doNotifyQueueEmpty	(	$	wiki,
		$	type
	)		[abstract, protected]

See also:

JobQueueAggregator::notifyQueueEmpty()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by notifyQueueEmpty().

JobQueueAggregator::doNotifyQueueNonEmpty	(	$	wiki,
		$	type
	)		[abstract, protected]

See also:

JobQueueAggregator::notifyQueueNonEmpty()

Reimplemented in JobQueueAggregatorMemc, and JobQueueAggregatorRedis.

Referenced by notifyQueueNonEmpty().

JobQueueAggregator::doPurge

(

)

[abstract, protected]

See also:

JobQueueAggregator::purge()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by purge().

JobQueueAggregator::findPendingWikiQueues

(

)

[protected]

Get all databases that have a pending job.

This poll all the queues and is this expensive.

Returns:

array (job type => (list of wiki IDs))

Definition at line 150 of file JobQueueAggregator.php.

References array(), as, global, and JobQueueGroup\singleton().

JobQueueAggregator::getAllReadyWikiQueues

(

)

[final]

Get the list of all of the queues with jobs.

Returns:

array (job type => (list of wiki IDs))

Definition at line 113 of file JobQueueAggregator.php.

References $res, doGetAllReadyWikiQueues(), wfProfileIn(), and wfProfileOut().

JobQueueAggregator::notifyQueueEmpty	(	$	wiki,
		$	type
	)		[final]

Mark a queue as being empty.

Parameters:

string	$wiki
string	$type

Returns:

bool Success

Definition at line 75 of file JobQueueAggregator.php.

References $ok, doNotifyQueueEmpty(), wfProfileIn(), and wfProfileOut().

JobQueueAggregator::notifyQueueNonEmpty	(	$	wiki,
		$	type
	)		[final]

Mark a queue as being non-empty.

Parameters:

string	$wiki
string	$type

Returns:

bool Success

Definition at line 95 of file JobQueueAggregator.php.

References $ok, doNotifyQueueNonEmpty(), wfProfileIn(), and wfProfileOut().

JobQueueAggregator::purge

(

)

[final]

Purge all of the aggregator information.

Returns:

bool Success

Definition at line 131 of file JobQueueAggregator.php.

References $res, doPurge(), wfProfileIn(), and wfProfileOut().

static JobQueueAggregator::singleton

(

)

[static, final]

Exceptions:

MWException

Returns:

JobQueueAggregator

Definition at line 44 of file JobQueueAggregator.php.

References $instance, and global.

Referenced by NextJobDB\execute().

---

Member Data Documentation

JobQueueAggregator::$instance = null [static, protected]

Definition at line 32 of file JobQueueAggregator.php.

Referenced by singleton().

---

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

• includes/jobqueue/aggregator/JobQueueAggregator.php