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.

	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 $ignored=[])
	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.

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)

string	$domain
	Wiki domain ID.

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

ConfiguredReadOnlyMode	$readOnlyMode
	Read only mode.

Detailed Description

Handle enqueueing of background jobs.

Since: 1.21

Definition at line 31 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 79 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 278 of file JobQueueGroup.php.

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

Referenced by ack().

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

Deprecated: since 1.40

Parameters

RunnableJob $job

Returns: bool

Definition at line 290 of file JobQueueGroup.php.

References wfDeprecated().

◆ 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, and JobQueue\factory().

Referenced by ApiUpload\__construct().

◆ getCoalescedQueues()

JobQueueGroup::getCoalescedQueues ( )

protected

Returns: array[]

Definition at line 403 of file JobQueueGroup.php.

References $type, JobQueue\factory(), and getQueueTypes().

Referenced by getQueueSizes(), and getQueuesWithJobs().

◆ getDefaultQueueTypes()

JobQueueGroup::getDefaultQueueTypes ( )

Get the list of default queue types.

Returns: string[]

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

References $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 356 of file JobQueueGroup.php.

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

Referenced by pop(), and queuesHaveJobs().

◆ getQueueTypes()

JobQueueGroup::getQueueTypes ( )

Get the list of queue types.

Returns: string[]

Definition at line 314 of file JobQueueGroup.php.

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

References 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|false Returns false on failure

Definition at line 227 of file JobQueueGroup.php.

References $job, $type, 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 132 of file JobQueueGroup.php.

References $job, $type, push(), and MapCacheLRU\set().

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

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

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

References $type, and waitForBackups().

Referenced by waitForBackups().

Member Data Documentation

◆ $cache

MapCacheLRU JobQueueGroup::$cache

protected

Definition at line 33 of file JobQueueGroup.php.

◆ $coalescedQueues

array JobQueueGroup::$coalescedQueues

protected

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

Definition at line 55 of file JobQueueGroup.php.

◆ $domain

string JobQueueGroup::$domain

protected

Wiki domain ID.

Definition at line 36 of file JobQueueGroup.php.

◆ $invalidDomain

bool JobQueueGroup::$invalidDomain = false

protected

Whether the wiki is not recognized in configuration.

Definition at line 40 of file JobQueueGroup.php.

◆ $readOnlyMode

ConfiguredReadOnlyMode JobQueueGroup::$readOnlyMode

protected

Read only mode.

Definition at line 38 of file JobQueueGroup.php.

◆ TYPE_DEFAULT

const JobQueueGroup::TYPE_DEFAULT = 1

Definition at line 57 of file JobQueueGroup.php.

◆ USE_CACHE

const JobQueueGroup::USE_CACHE = 1

Definition at line 60 of file JobQueueGroup.php.

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

includes/jobqueue/JobQueueGroup.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ ack()

◆ deduplicateRootJob()

◆ get()

◆ getCoalescedQueues()

◆ getDefaultQueueTypes()

◆ getQueueSizes()

◆ getQueuesWithJobs()

◆ getQueueTypes()

◆ lazyPush()

◆ pop()

◆ push()

◆ queuesHaveJobs()

◆ waitForBackups()

Member Data Documentation

◆ $cache

◆ $coalescedQueues

◆ $domain

◆ $invalidDomain

◆ $readOnlyMode

◆ TYPE_DEFAULT

◆ USE_CACHE