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

Collaboration diagram for JobQueueGroup:

[legend]

Public Member Functions
	ack (RunnableJob $job)
	Acknowledge that a job was completed.

	deduplicateRootJob (RunnableJob $job)
	Register the "root job" of a given job into the queue for de-duplication.

	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 queues 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.

	lazyPush ( $jobs)
	Buffer jobs for insertion via push() or call it now if in CLI mode.

	pop ( $qtype=self::TYPE_DEFAULT, $flags=0, array $blacklist=[])
	Pop a job off one of the job queues.

	push ( $jobs)
	Insert jobs into the respective queues of which they belong.

	queuesHaveJobs ( $type=self::TYPE_ANY)
	Check if there are any queues with jobs (this is cached)

	waitForBackups ()
	Wait for any replica DBs or backup queue servers to catch up.

Static Public Member Functions
static	destroySingletons ()
	Destroy the singleton instances.

static	singleton ( $domain=false)

Public Attributes
const	TYPE_DEFAULT = 1

const	USE_CACHE = 1

Protected Member Functions
	__construct ( $domain, $readOnlyReason)

	getCoalescedQueues ()

Protected Attributes
MapCacheLRU	$cache

array	$coalescedQueues
	Map of (bucket => (queue => JobQueue, types => list of types)

string	$domain
	Wiki domain ID.

bool	$invalidDomain = false
	Whether the wiki is not recognized in configuration.

string bool	$readOnlyReason
	Read only rationale (or false if r/w)

Static Protected Attributes
static JobQueueGroup[]	$instances = []

Private Member Functions
	assertValidJobs (array $jobs)

	factoryJobQueue (array $conf)

	getCachedConfigVar ( $name)

Private Attributes
const	CACHE_VERSION = 1

const	PROC_CACHE_TTL = 15

const	TYPE_ANY = 2

Detailed Description

Class to handle enqueueing of background jobs.

Since: 1.21

Definition at line 30 of file JobQueueGroup.php.

Constructor & Destructor Documentation

◆ __construct()

JobQueueGroup::__construct	(	$domain,
		$readOnlyReason
	)

protected

Parameters

string	$domain	Wiki domain ID
string \| bool	$readOnlyReason	Read-only reason or false

Definition at line 60 of file JobQueueGroup.php.

Member Function Documentation

◆ ack()

JobQueueGroup::ack ( RunnableJob $job )

Acknowledge that a job was completed.

Parameters

RunnableJob $job

Returns: void

Definition at line 286 of file JobQueueGroup.php.

References $job, ack(), and IJobSpecification\getType().

Referenced by ack().

◆ assertValidJobs()

JobQueueGroup::assertValidJobs ( array $jobs )

private

Parameters

array $jobs

Exceptions

InvalidArgumentException

Definition at line 470 of file JobQueueGroup.php.

References $job.

Referenced by lazyPush(), and push().

◆ deduplicateRootJob()

JobQueueGroup::deduplicateRootJob ( RunnableJob $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

RunnableJob $job

Returns: bool

Definition at line 297 of file JobQueueGroup.php.

References $job, deduplicateRootJob(), and IJobSpecification\getType().

Referenced by deduplicateRootJob().

◆ destroySingletons()

static JobQueueGroup::destroySingletons ( )

static

Destroy the singleton instances.

Returns: void

Definition at line 98 of file JobQueueGroup.php.

◆ factoryJobQueue()

JobQueueGroup::factoryJobQueue ( array $conf )

private

Parameters

array $conf

Returns: JobQueue

Exceptions

JobQueueError

Definition at line 129 of file JobQueueGroup.php.

References JobQueue\factory().

Referenced by get(), and getCoalescedQueues().

◆ get()

JobQueueGroup::get ( $type )

Get the job queue object for a given queue type.

Parameters

string $type

Returns: JobQueue

Definition at line 108 of file JobQueueGroup.php.

References $type, $wgJobTypeConf, and factoryJobQueue().

◆ getCachedConfigVar()

JobQueueGroup::getCachedConfigVar ( $name )

private

Parameters

string $name

Returns: mixed

Definition at line 444 of file JobQueueGroup.php.

References $cache, $GLOBALS, and $wgConf.

Referenced by getQueueTypes().

◆ getCoalescedQueues()

JobQueueGroup::getCoalescedQueues ( )

protected

Returns: array[] -return array<string,array{queue:JobQueue,types:array<string,class-string>}>

Definition at line 413 of file JobQueueGroup.php.

References $queue, $type, $wgJobTypeConf, factoryJobQueue(), and getQueueTypes().

Referenced by getQueueSizes(), and getQueuesWithJobs().

◆ getDefaultQueueTypes()

JobQueueGroup::getDefaultQueueTypes ( )

Get the list of default queue types.

Returns: array List of strings

Definition at line 331 of file JobQueueGroup.php.

References $wgJobTypesExcludedFromDefaultQueue, and getQueueTypes().

Referenced by pop(), and queuesHaveJobs().

◆ getQueueSizes()

JobQueueGroup::getQueueSizes ( )

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

Returns: int[] Map of (job type => size)

Definition at line 391 of file JobQueueGroup.php.

References $queue, $type, getCoalescedQueues(), and getQueueTypes().

◆ getQueuesWithJobs()

JobQueueGroup::getQueuesWithJobs ( )

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

Returns: string[] List of job types that have non-empty queues

Definition at line 366 of file JobQueueGroup.php.

References $queue, $type, getCoalescedQueues(), and getQueueTypes().

Referenced by pop(), and queuesHaveJobs().

◆ getQueueTypes()

JobQueueGroup::getQueueTypes ( )

Get the list of queue types.

Returns: array List of strings

Definition at line 322 of file JobQueueGroup.php.

References getCachedConfigVar().

Referenced by getCoalescedQueues(), getDefaultQueueTypes(), getQueueSizes(), and getQueuesWithJobs().

◆ lazyPush()

JobQueueGroup::lazyPush ( $jobs )

Buffer jobs for insertion via push() or call it now if in CLI mode.

Parameters

IJobSpecification | IJobSpecification[] $jobs A single Job or a list of Jobs

Returns: void

Since: 1.26

Definition at line 203 of file JobQueueGroup.php.

References assertValidJobs(), and push().

◆ pop()

JobQueueGroup::pop	(		$qtype = `self::TYPE_DEFAULT`,
			$flags = `0`,
		array	$blacklist = `[]`
	)

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

int \| string	$qtype	JobQueueGroup::TYPE_* constant or job type string
int	$flags	Bitfield of JobQueueGroup::USE_* constants
array	$blacklist	List of job types to ignore

Returns: RunnableJob|bool Returns false on failure

Definition at line 233 of file JobQueueGroup.php.

References $job, $type, $wgJobClasses, getDefaultQueueTypes(), getQueuesWithJobs(), and pop().

Referenced by pop().

◆ push()

JobQueueGroup::push ( $jobs )

Insert jobs into the respective queues of which they belong.

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

Parameters

IJobSpecification | IJobSpecification[] $jobs A single Job or a list of Jobs

Exceptions

InvalidArgumentException

Returns: void

Definition at line 148 of file JobQueueGroup.php.

References $cache, $job, $type, $wgJobTypesExcludedFromDefaultQueue, assertValidJobs(), and push().

Referenced by lazyPush(), and push().

◆ queuesHaveJobs()

JobQueueGroup::queuesHaveJobs ( $type = self::TYPE_ANY )

Check if there are any queues with jobs (this is cached)

Parameters

int $type JobQueueGroup::TYPE_* constant

Returns: bool

Since: 1.23

Definition at line 344 of file JobQueueGroup.php.

References $cache, $type, getDefaultQueueTypes(), and getQueuesWithJobs().

◆ singleton()

static JobQueueGroup::singleton ( $domain = false )

static

Parameters

bool | string $domain Wiki domain ID

Returns: JobQueueGroup

Definition at line 70 of file JobQueueGroup.php.

References $wgLocalDatabases, and wfConfiguredReadOnlyReason().

◆ waitForBackups()

JobQueueGroup::waitForBackups ( )

Wait for any replica DBs or backup queue servers to catch up.

This does nothing for certain queue classes.

Returns: void

Definition at line 308 of file JobQueueGroup.php.

References $type, $wgJobTypeConf, and waitForBackups().

Referenced by waitForBackups().

Member Data Documentation

◆ $cache

MapCacheLRU JobQueueGroup::$cache

protected

Definition at line 35 of file JobQueueGroup.php.

◆ $coalescedQueues

array JobQueueGroup::$coalescedQueues

protected

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

Definition at line 45 of file JobQueueGroup.php.

◆ $domain

string JobQueueGroup::$domain

protected

Wiki domain ID.

Definition at line 38 of file JobQueueGroup.php.

◆ $instances

JobQueueGroup [] JobQueueGroup::$instances = []

staticprotected

Definition at line 32 of file JobQueueGroup.php.

◆ $invalidDomain

bool JobQueueGroup::$invalidDomain = false

protected

Whether the wiki is not recognized in configuration.

Definition at line 42 of file JobQueueGroup.php.

◆ $readOnlyReason

string bool JobQueueGroup::$readOnlyReason

protected

Read only rationale (or false if r/w)

Definition at line 40 of file JobQueueGroup.php.

◆ CACHE_VERSION

const JobQueueGroup::CACHE_VERSION = 1

private

Definition at line 54 of file JobQueueGroup.php.

◆ PROC_CACHE_TTL

const JobQueueGroup::PROC_CACHE_TTL = 15

private

Definition at line 52 of file JobQueueGroup.php.

◆ TYPE_ANY

const JobQueueGroup::TYPE_ANY = 2

private

Definition at line 48 of file JobQueueGroup.php.

◆ TYPE_DEFAULT

const JobQueueGroup::TYPE_DEFAULT = 1

Definition at line 47 of file JobQueueGroup.php.

◆ USE_CACHE

const JobQueueGroup::USE_CACHE = 1

Definition at line 50 of file JobQueueGroup.php.

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

includes/jobqueue/JobQueueGroup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ ack()

◆ assertValidJobs()

◆ deduplicateRootJob()

◆ destroySingletons()

◆ factoryJobQueue()

◆ get()

◆ getCachedConfigVar()

◆ getCoalescedQueues()

◆ getDefaultQueueTypes()

◆ getQueueSizes()

◆ getQueuesWithJobs()

◆ getQueueTypes()

◆ lazyPush()

◆ pop()

◆ push()

◆ queuesHaveJobs()

◆ singleton()

◆ waitForBackups()

Member Data Documentation

◆ $cache

◆ $coalescedQueues

◆ $domain

◆ $instances

◆ $invalidDomain

◆ $readOnlyReason

◆ CACHE_VERSION

◆ PROC_CACHE_TTL

◆ TYPE_ANY

◆ TYPE_DEFAULT

◆ USE_CACHE