JobQueueAggregator Class Reference

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

Inheritance diagram for JobQueueAggregator:

Public Member Functions
	getAllReadyWikiQueues ()
	Get the list of all of the queues with jobs. More...
	notifyQueueEmpty ( $wiki, $type)
	Mark a queue as being empty. More...
	notifyQueueNonEmpty ( $wiki, $type)
	Mark a queue as being non-empty. More...
	purge ()
	Purge all of the aggregator information. More...

Static Public Member Functions
static	destroySingleton ()
	Destroy the singleton instance. More...
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. More...

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

__construct()

JobQueueAggregator::__construct ( array  $params )

protected

Parameters

array

$params

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Definition at line 37 of file JobQueueAggregator.php.

Member Function Documentation

destroySingleton()

static JobQueueAggregator::destroySingleton ( )

staticfinal

Destroy the singleton instance.

Returns

void

Definition at line 64 of file JobQueueAggregator.php.

doGetAllReadyWikiQueues()

JobQueueAggregator::doGetAllReadyWikiQueues ( )

abstractprotected

See also

JobQueueAggregator::getAllReadyWikiQueues()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by getAllReadyWikiQueues().

doNotifyQueueEmpty()

JobQueueAggregator::doNotifyQueueEmpty (   $wiki,   $type  )

abstractprotected

See also

JobQueueAggregator::notifyQueueEmpty()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by notifyQueueEmpty().

doNotifyQueueNonEmpty()

JobQueueAggregator::doNotifyQueueNonEmpty (   $wiki,   $type  )

abstractprotected

See also

JobQueueAggregator::notifyQueueNonEmpty()

Reimplemented in JobQueueAggregatorMemc, and JobQueueAggregatorRedis.

Referenced by notifyQueueNonEmpty().

doPurge()

JobQueueAggregator::doPurge ( )

abstractprotected

See also

JobQueueAggregator::purge()

Reimplemented in JobQueueAggregatorRedis, and JobQueueAggregatorMemc.

Referenced by purge().

findPendingWikiQueues()

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 $type, array(), as, global, and JobQueueGroup\singleton().

Referenced by JobQueueAggregatorMemc\doGetAllReadyWikiQueues(), and JobQueueAggregatorRedis\doGetAllReadyWikiQueues().

getAllReadyWikiQueues()

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().

notifyQueueEmpty()

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, $type, doNotifyQueueEmpty(), wfProfileIn(), and wfProfileOut().

notifyQueueNonEmpty()

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, $type, doNotifyQueueNonEmpty(), wfProfileIn(), and wfProfileOut().

purge()

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().

singleton()

static JobQueueAggregator::singleton ( )

staticfinal

Exceptions

MWException

Returns

JobQueueAggregator

Definition at line 44 of file JobQueueAggregator.php.

References $instance, and global.

Referenced by NextJobDB\execute(), JobQueueGroup\executeReadyPeriodicTasks(), JobQueueGroup\pop(), and JobQueueGroup\push().

Member Data Documentation

$instance

JobQueueAggregator::$instance = null

staticprotected

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