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

Collaboration diagram for JobQueueGroup:

[legend]

Public Member Functions
	__construct ( $domain, ConfiguredReadOnlyMode $readOnlyMode, bool $invalidDomain, array $jobClasses, array $jobTypeConfiguration, array $jobTypesExcludedFromDefaultQueue, IBufferingStatsdDataFactory $statsdDataFactory, WANObjectCache $wanCache, GlobalIdGenerator $globalIdGenerator)

	ack (RunnableJob $job)
	Acknowledge that a job was completed. More...

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

	get ( $type)
	Get the job queue object for a given queue type. More...

	getDefaultQueueTypes ()
	Get the list of default queue types. More...

	getQueueSizes ()
	Get the size of the queues for a list of job types. More...

	getQueuesWithJobs ()
	Get the list of job types that have non-empty queues. More...

	getQueueTypes ()
	Get the list of queue types. More...

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

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

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

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

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

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

static	singleton ( $domain=false)

Public Attributes
const	TYPE_DEFAULT = 1

const	USE_CACHE = 1

Protected Member Functions
	getCoalescedQueues ()

Protected Attributes
MapCacheLRU	$cache

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

string	$domain
	Wiki domain ID. More...

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

ConfiguredReadOnlyMode	$readOnlyMode
	Read only mode. More...

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

Private Member Functions
	assertValidJobs (array $jobs)

	getCachedConfigVar ( $name)

Private Attributes
GlobalIdGenerator	$globalIdGenerator

array	$jobClasses

array	$jobTypeConfiguration

array	$jobTypesExcludedFromDefaultQueue

IBufferingStatsdDataFactory	$statsdDataFactory

WANObjectCache	$wanCache

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 32 of file JobQueueGroup.php.

Constructor & Destructor Documentation

◆ __construct()

JobQueueGroup::__construct	(		$domain,
		ConfiguredReadOnlyMode	$readOnlyMode,
		bool	$invalidDomain,
		array	$jobClasses,
		array	$jobTypeConfiguration,
		array	$jobTypesExcludedFromDefaultQueue,
		IBufferingStatsdDataFactory	$statsdDataFactory,
		WANObjectCache	$wanCache,
		GlobalIdGenerator	$globalIdGenerator
	)

Access: internal: Use MediaWikiServices::getJobQueueGroupFactory

Parameters

string	$domain	Wiki domain ID
ConfiguredReadOnlyMode	$readOnlyMode	Read-only mode
bool	$invalidDomain	Whether the wiki is not recognized in configuration
array	$jobClasses
array	$jobTypeConfiguration
array	$jobTypesExcludedFromDefaultQueue
IBufferingStatsdDataFactory	$statsdDataFactory
WANObjectCache	$wanCache
GlobalIdGenerator	$globalIdGenerator

Definition at line 86 of file JobQueueGroup.php.

References $domain, $globalIdGenerator, $invalidDomain, $jobClasses, $jobTypeConfiguration, $jobTypesExcludedFromDefaultQueue, $readOnlyMode, $statsdDataFactory, and $wanCache.

Member Function Documentation

◆ ack()

JobQueueGroup::ack ( RunnableJob $job )

Acknowledge that a job was completed.

Parameters

RunnableJob $job

Returns: void

Definition at line 307 of file JobQueueGroup.php.

References $job, and IJobSpecification\getType().

◆ assertValidJobs()

JobQueueGroup::assertValidJobs ( array $jobs )

private

Parameters

array $jobs

Exceptions

InvalidArgumentException

Definition at line 490 of file JobQueueGroup.php.

References $job, and $type.

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 318 of file JobQueueGroup.php.

References $job, and IJobSpecification\getType().

◆ destroySingletons()

static JobQueueGroup::destroySingletons ( )

static

Destroy the singleton instances.

Deprecated:: since 1.37

Returns: void

Definition at line 124 of file JobQueueGroup.php.

Referenced by ForkController\prepareEnvironment().

◆ get()

JobQueueGroup::get ( $type )

Get the job queue object for a given queue type.

Parameters

string $type

Returns: JobQueue

Definition at line 133 of file JobQueueGroup.php.

References $domain, $globalIdGenerator, $statsdDataFactory, $type, $wanCache, and JobQueue\factory().

◆ getCachedConfigVar()

JobQueueGroup::getCachedConfigVar ( $name )

private

Parameters

string $name

Returns: mixed

Definition at line 464 of file JobQueueGroup.php.

References $cache, $wgConf, WikiMap\getWikiIdFromDbDomain(), MapCacheLRU\getWithSetCallback(), and WikiMap\isCurrentWikiDbDomain().

Referenced by getQueueTypes().

◆ getCoalescedQueues()

JobQueueGroup::getCoalescedQueues ( )

protected

Returns: array[]

Definition at line 430 of file JobQueueGroup.php.

References $coalescedQueues, $domain, $globalIdGenerator, $queue, $statsdDataFactory, $type, $wanCache, JobQueue\factory(), and getQueueTypes().

Referenced by getQueueSizes(), and getQueuesWithJobs().

◆ getDefaultQueueTypes()

JobQueueGroup::getDefaultQueueTypes ( )

Get the list of default queue types.

Returns: string[]

Definition at line 350 of file JobQueueGroup.php.

References 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 408 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 383 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: string[]

Definition at line 341 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 226 of file JobQueueGroup.php.

References DeferredUpdates\addUpdate(), assertValidJobs(), and push().

◆ pop()

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

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	$ignored	List of job types to ignore

Returns: RunnableJob|bool Returns false on failure

Definition at line 256 of file JobQueueGroup.php.

References $job, $type, getDefaultQueueTypes(), getQueuesWithJobs(), and WikiMap\isCurrentWikiDbDomain().

◆ 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 161 of file JobQueueGroup.php.

References $cache, $job, $type, assertValidJobs(), ObjectCache\getLocalClusterInstance(), MWExceptionHandler\logException(), and MapCacheLRU\set().

Referenced by lazyPush().

◆ 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 361 of file JobQueueGroup.php.

References $cache, $type, MapCacheLRU\get(), getDefaultQueueTypes(), ObjectCache\getLocalClusterInstance(), and getQueuesWithJobs().

◆ singleton()

static JobQueueGroup::singleton ( $domain = false )

static

Deprecated:: since 1.37 Use JobQueueGroupFactory::makeJobQueueGroup

Parameters

bool | string $domain Wiki domain ID

Returns: JobQueueGroup

Definition at line 114 of file JobQueueGroup.php.

References $domain.

◆ 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 329 of file JobQueueGroup.php.

References $type.

Member Data Documentation

◆ $cache

MapCacheLRU JobQueueGroup::$cache

protected

Definition at line 40 of file JobQueueGroup.php.

Referenced by getCachedConfigVar(), push(), and queuesHaveJobs().

◆ $coalescedQueues

array JobQueueGroup::$coalescedQueues

protected

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

Definition at line 62 of file JobQueueGroup.php.

Referenced by getCoalescedQueues().

◆ $domain

string JobQueueGroup::$domain

protected

Wiki domain ID.

Definition at line 43 of file JobQueueGroup.php.

Referenced by __construct(), get(), getCoalescedQueues(), and singleton().

◆ $globalIdGenerator

GlobalIdGenerator JobQueueGroup::$globalIdGenerator

private

Definition at line 59 of file JobQueueGroup.php.

Referenced by __construct(), get(), and getCoalescedQueues().

◆ $instances

JobQueueGroup [] JobQueueGroup::$instances = []

staticprotected

Deprecated:: since 1.37

Definition at line 37 of file JobQueueGroup.php.

◆ $invalidDomain

bool JobQueueGroup::$invalidDomain = false

protected

Whether the wiki is not recognized in configuration.

Definition at line 47 of file JobQueueGroup.php.

Referenced by __construct().

◆ $jobClasses

array JobQueueGroup::$jobClasses

private

Definition at line 49 of file JobQueueGroup.php.

Referenced by __construct().

◆ $jobTypeConfiguration

array JobQueueGroup::$jobTypeConfiguration

private

Definition at line 51 of file JobQueueGroup.php.

Referenced by __construct().

◆ $jobTypesExcludedFromDefaultQueue

array JobQueueGroup::$jobTypesExcludedFromDefaultQueue

private

Definition at line 53 of file JobQueueGroup.php.

Referenced by __construct().

◆ $readOnlyMode

ConfiguredReadOnlyMode JobQueueGroup::$readOnlyMode

protected

Read only mode.

Definition at line 45 of file JobQueueGroup.php.

Referenced by __construct().

◆ $statsdDataFactory

IBufferingStatsdDataFactory JobQueueGroup::$statsdDataFactory

private

Definition at line 55 of file JobQueueGroup.php.

Referenced by __construct(), get(), and getCoalescedQueues().

◆ $wanCache

WANObjectCache JobQueueGroup::$wanCache

private

Definition at line 57 of file JobQueueGroup.php.

Referenced by __construct(), get(), and getCoalescedQueues().

◆ CACHE_VERSION

const JobQueueGroup::CACHE_VERSION = 1

private

Definition at line 71 of file JobQueueGroup.php.

◆ PROC_CACHE_TTL

const JobQueueGroup::PROC_CACHE_TTL = 15

private

Definition at line 69 of file JobQueueGroup.php.

◆ TYPE_ANY

const JobQueueGroup::TYPE_ANY = 2

private

Definition at line 65 of file JobQueueGroup.php.

◆ TYPE_DEFAULT

const JobQueueGroup::TYPE_DEFAULT = 1

Definition at line 64 of file JobQueueGroup.php.

Referenced by JobRunner\run(), and MediaWiki\triggerAsyncJobs().

◆ USE_CACHE

const JobQueueGroup::USE_CACHE = 1

Definition at line 67 of file JobQueueGroup.php.

Referenced by JobRunner\run().

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

◆ get()

◆ getCachedConfigVar()

◆ getCoalescedQueues()

◆ getDefaultQueueTypes()

◆ getQueueSizes()

◆ getQueuesWithJobs()

◆ getQueueTypes()

◆ lazyPush()

◆ pop()

◆ push()

◆ queuesHaveJobs()

◆ singleton()

◆ waitForBackups()

Member Data Documentation

◆ $cache

◆ $coalescedQueues

◆ $domain

◆ $globalIdGenerator

◆ $instances

◆ $invalidDomain

◆ $jobClasses

◆ $jobTypeConfiguration

◆ $jobTypesExcludedFromDefaultQueue

◆ $readOnlyMode

◆ $statsdDataFactory

◆ $wanCache

◆ CACHE_VERSION

◆ PROC_CACHE_TTL

◆ TYPE_ANY

◆ TYPE_DEFAULT

◆ USE_CACHE