Class to handle enqueueing of background jobs. More...

Collaboration diagram for JobQueueGroup:

Public Member Functions
	ack (Job $job)
	Acknowledge that a job was completed.
	deduplicateRootJob (Job $job)
	Register the "root job" of a given job into the queue for de-duplication.
	executeReadyPeriodicTasks ()
	Execute any due periodic queue maintenance tasks for all queues.
	get ($type)
	Get the job queue object for a given queue type.
	getDefaultQueueTypes ()
	Get the list of default queue types.
	getQueueSizes ()
	Get the size of the queus for a list of job types.
	getQueuesWithJobs ()
	Get the list of job types that have non-empty queues.
	getQueueTypes ()
	Get the list of queue types.
	isQueueDeprioritized ($type)
	Check if jobs should not be popped of a queue right now.
	pop ($qtype=self::TYPE_DEFAULT, $flags=0)
	Pop a job off one of the job queues.
	push ($jobs)
	Insert jobs into the respective queues of with the belong.
	waitForBackups ()
	Wait for any slaves or backup queue servers to catch up.
Static Public Member Functions
static	destroySingletons ()
	Destroy the singleton instances.
static	singleton ($wiki=false)
Public Attributes
const	CACHE_VERSION = 1
const	PROC_CACHE_TTL = 15
const	TYPE_ANY = 2
const	TYPE_DEFAULT = 1
const	USE_CACHE = 1
const	USE_PRIORITY = 2
Protected Member Functions
	__construct ($wiki)
	getCoalescedQueues ()
Protected Attributes
ProcessCacheLRU	$cache
	*
array	$coalescedQueues
	Map of (bucket => (queue => JobQueue, types => list of types) *.
	$wiki
Static Protected Attributes
static	$instances = array()
Private Member Functions
	getCachedConfigVar ($name)

Detailed Description

Class to handle enqueueing of background jobs.

Since:: 1.21

Definition at line 30 of file JobQueueGroup.php.

Constructor & Destructor Documentation

JobQueueGroup::__construct ( $ wiki ) [protected]

Parameters:

string $wiki Wiki ID

Definition at line 53 of file JobQueueGroup.php.

Member Function Documentation

JobQueueGroup::ack ( Job $ job )

Acknowledge that a job was completed.

Parameters:

$job Job

Returns:: bool

Definition at line 197 of file JobQueueGroup.php.

JobQueueGroup::deduplicateRootJob ( Job $ job )

Register the "root job" of a given job into the queue for de-duplication.

This should only be called right *after* all the new jobs have been inserted.

Parameters:

$job Job

Returns:: bool

Definition at line 208 of file JobQueueGroup.php.

static JobQueueGroup::destroySingletons ( ) [static]

Destroy the singleton instances.

Returns:: void

Definition at line 75 of file JobQueueGroup.php.

Referenced by TemplateCategoriesTest\testTemplateCategories().

JobQueueGroup::executeReadyPeriodicTasks ( )

Execute any due periodic queue maintenance tasks for all queues.

A task is "due" if the time ellapsed since the last run is greater than the defined run period. Concurrent calls to this function will cause tasks to be attempted twice, so they may need their own methods of mutual exclusion.

Returns:: integer Number of tasks run

Definition at line 354 of file JobQueueGroup.php.

JobQueueGroup::get ( $ type )

Get the job queue object for a given queue type.

Parameters:

$type string

Returns:: JobQueue

Definition at line 85 of file JobQueueGroup.php.

JobQueueGroup::getCachedConfigVar ( $ name ) [private]

Parameters:

$name string

Returns:: mixed

Definition at line 407 of file JobQueueGroup.php.

JobQueueGroup::getCoalescedQueues ( ) [protected]

Returns:: array

Definition at line 296 of file JobQueueGroup.php.

JobQueueGroup::getDefaultQueueTypes ( )

Get the list of default queue types.

Returns:: array List of strings

Definition at line 245 of file JobQueueGroup.php.

JobQueueGroup::getQueueSizes ( )

Get the size of the queus for a list of job types.

Returns:: Array Map of (job type => size)

Definition at line 278 of file JobQueueGroup.php.

JobQueueGroup::getQueuesWithJobs ( )

Get the list of job types that have non-empty queues.

Returns:: Array List of job types that have non-empty queues

Definition at line 256 of file JobQueueGroup.php.

JobQueueGroup::getQueueTypes ( )

Get the list of queue types.

Returns:: array List of strings

Definition at line 236 of file JobQueueGroup.php.

JobQueueGroup::isQueueDeprioritized ( $ type )

Check if jobs should not be popped of a queue right now.

This is only used for performance, such as to avoid spamming the queue with many sub-jobs before they actually get run.

Parameters:

$type string

Returns:: bool

Definition at line 331 of file JobQueueGroup.php.

JobQueueGroup::pop	(	$	qtype = `self::TYPE_DEFAULT`,
		$	flags = `0`
	)

Pop a job off one of the job queues.

This pops a job off a queue as specified by $wgJobTypeConf and updates the aggregate job queue information cache as needed.

Parameters:

$qtype	integer\|string JobQueueGroup::TYPE_DEFAULT or type string
$flags	integer Bitfield of JobQueueGroup::USE_* constants

Returns:: Job|bool Returns false on failure

Definition at line 149 of file JobQueueGroup.php.

JobQueueGroup::push ( $ jobs )

Insert jobs into the respective queues of with the belong.

This inserts the jobs into the queue specified by $wgJobTypeConf and updates the aggregate job queue information cache as needed.

Parameters:

$jobs Job|array A single Job or a list of Jobs

Exceptions:

MWException

Returns:: bool

Definition at line 108 of file JobQueueGroup.php.

static JobQueueGroup::singleton ( $ wiki = false ) [static]

Parameters:

string $wiki Wiki ID

Returns:: JobQueueGroup

Definition at line 62 of file JobQueueGroup.php.

Referenced by UploadFromUrlTest\doAsyncUpload(), HTMLCacheUpdate\doUpdate(), nextJobDB\execute(), CopyJobQueue\execute(), ShowJobs\execute(), RunJobs\execute(), nextJobDB\executeReadyPeriodicTasks(), JobQueueAggregator\findPendingWikiQueues(), DoubleRedirectJob\fixRedirects(), UploadFromUrl\insertJob(), SiteStats\jobs(), FixDoubleRedirects\queueJobs(), NullJob\run(), RefreshLinksJob2\run(), UploadFromUrlTest\testClearQueue(), UploadFromUrlTest\testLeaveMessage(), UploadFromUrlTest\testSetupUrlDownload(), and UploadFromUrlTest\testSyncDownload().

JobQueueGroup::waitForBackups ( )

Wait for any slaves or backup queue servers to catch up.

This does nothing for certain queue classes.

Returns:: void

Exceptions:

MWException

Definition at line 220 of file JobQueueGroup.php.

Member Data Documentation

ProcessCacheLRU JobQueueGroup::$cache [protected]

*

Definition at line 34 of file JobQueueGroup.php.

array JobQueueGroup::$coalescedQueues [protected]

Map of (bucket => (queue => JobQueue, types => list of types) *.

Definition at line 38 of file JobQueueGroup.php.

JobQueueGroup::$instances = array() [static, protected]

Definition at line 32 of file JobQueueGroup.php.

JobQueueGroup::$wiki [protected]

Definition at line 36 of file JobQueueGroup.php.

const JobQueueGroup::CACHE_VERSION = 1

Definition at line 48 of file JobQueueGroup.php.

const JobQueueGroup::PROC_CACHE_TTL = 15

Definition at line 46 of file JobQueueGroup.php.

const JobQueueGroup::TYPE_ANY = 2

Definition at line 41 of file JobQueueGroup.php.

const JobQueueGroup::TYPE_DEFAULT = 1

Definition at line 40 of file JobQueueGroup.php.

Referenced by RunJobs\execute().

const JobQueueGroup::USE_CACHE = 1

Definition at line 43 of file JobQueueGroup.php.

Referenced by RunJobs\execute().

const JobQueueGroup::USE_PRIORITY = 2

Definition at line 44 of file JobQueueGroup.php.

Referenced by RunJobs\execute().

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

includes/job/JobQueueGroup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation