JobQueueAggregator Class Reference

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

Inheritance diagram for JobQueueAggregator:

Collaboration diagram for JobQueueAggregator:

Public Member Functions
	__construct (array $params)
	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
	doGetAllReadyWikiQueues ()
	doNotifyQueueEmpty ($wiki, $type)
	doNotifyQueueNonEmpty ($wiki, $type)
	doPurge ()
	findPendingWikiQueues ()
	Get all databases that have a pending job. More...

Static Protected Attributes
static JobQueueAggregator	$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

)

Parameters

array

$params

Definition at line 37 of file JobQueueAggregator.php.

Member Function Documentation

static JobQueueAggregator::destroySingleton ( )

staticfinal

Destroy the singleton instance.

Returns

void

Definition at line 64 of file JobQueueAggregator.php.

JobQueueAggregator::doGetAllReadyWikiQueues ( )

abstractprotected

See Also

JobQueueAggregator::getAllReadyWikiQueues()

Referenced by getAllReadyWikiQueues().

JobQueueAggregator::doNotifyQueueEmpty (   $wiki,   $type  )

abstractprotected

See Also

JobQueueAggregator::notifyQueueEmpty()

Referenced by notifyQueueEmpty().

JobQueueAggregator::doNotifyQueueNonEmpty (   $wiki,   $type  )

abstractprotected

See Also

JobQueueAggregator::notifyQueueNonEmpty()

Referenced by notifyQueueNonEmpty().

JobQueueAggregator::doPurge ( )

abstractprotected

See Also

JobQueueAggregator::purge()

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 142 of file JobQueueAggregator.php.

References $type, $wgLocalDatabases, 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 109 of file JobQueueAggregator.php.

References $res, and doGetAllReadyWikiQueues().

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

JobQueueAggregator::notifyQueueNonEmpty (   $wiki,   $type  )

final

Mark a queue as being non-empty.

Parameters

string	$wiki
string	$type

Returns

bool Success

Definition at line 93 of file JobQueueAggregator.php.

References $type, and doNotifyQueueNonEmpty().

JobQueueAggregator::purge ( )

final

Purge all of the aggregator information.

Returns

bool Success

Definition at line 125 of file JobQueueAggregator.php.

References $res, and doPurge().

static JobQueueAggregator::singleton ( )

staticfinal

Exceptions

MWException

Returns

JobQueueAggregator

Definition at line 44 of file JobQueueAggregator.php.

References $wgJobQueueAggregator, and global.

Referenced by JobQueueGroup\get().

Member Data Documentation

JobQueueAggregator JobQueueAggregator::$instance = null

staticprotected

Definition at line 32 of file JobQueueAggregator.php.

---

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

• includes/jobqueue/aggregator/JobQueueAggregator.php