MediaWiki 1.41.2
|
Handle enqueueing of background jobs. More...
Public Member Functions | |
__construct ( $domain, ReadOnlyMode $readOnlyMode, ?array $localJobClasses, 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 one job off a job queue. | |
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. | |
ReadOnlyMode | $readOnlyMode |
Read only mode. | |
Handle enqueueing of background jobs.
Definition at line 34 of file JobQueueGroup.php.
JobQueueGroup::__construct | ( | $domain, | |
ReadOnlyMode | $readOnlyMode, | ||
?array | $localJobClasses, | ||
array | $jobTypeConfiguration, | ||
array | $jobTypesExcludedFromDefaultQueue, | ||
IBufferingStatsdDataFactory | $statsdDataFactory, | ||
WANObjectCache | $wanCache, | ||
GlobalIdGenerator | $globalIdGenerator ) |
string | $domain | Wiki domain ID |
ReadOnlyMode | $readOnlyMode | Read-only mode |
array | null | $localJobClasses | |
array | $jobTypeConfiguration | |
array | $jobTypesExcludedFromDefaultQueue | |
IBufferingStatsdDataFactory | $statsdDataFactory | |
WANObjectCache | $wanCache | |
GlobalIdGenerator | $globalIdGenerator |
Definition at line 77 of file JobQueueGroup.php.
JobQueueGroup::ack | ( | RunnableJob | $job | ) |
Acknowledge that a job was completed.
RunnableJob | $job |
Definition at line 265 of file JobQueueGroup.php.
References $job, ack(), and IJobSpecification\getType().
Referenced by ack().
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.
RunnableJob | $job |
Definition at line 277 of file JobQueueGroup.php.
References wfDeprecated().
JobQueueGroup::get | ( | $type | ) |
Get the job queue object for a given queue type.
string | $type |
Definition at line 104 of file JobQueueGroup.php.
References JobQueue\factory().
Referenced by ApiUpload\__construct().
|
protected |
Definition at line 406 of file JobQueueGroup.php.
References JobQueue\factory(), and getQueueTypes().
Referenced by getQueueSizes(), and getQueuesWithJobs().
JobQueueGroup::getDefaultQueueTypes | ( | ) |
Get the list of default queue types.
Definition at line 320 of file JobQueueGroup.php.
References getQueueTypes().
Referenced by pop(), and queuesHaveJobs().
JobQueueGroup::getQueueSizes | ( | ) |
Get the size of the queues for a list of job types.
Definition at line 384 of file JobQueueGroup.php.
References getCoalescedQueues(), and getQueueTypes().
JobQueueGroup::getQueuesWithJobs | ( | ) |
Get the list of job types that have non-empty queues.
Definition at line 357 of file JobQueueGroup.php.
References getCoalescedQueues(), and getQueueTypes().
Referenced by pop(), and queuesHaveJobs().
JobQueueGroup::getQueueTypes | ( | ) |
Get the list of queue types.
Definition at line 306 of file JobQueueGroup.php.
Referenced by getCoalescedQueues(), getDefaultQueueTypes(), getQueueSizes(), and getQueuesWithJobs().
JobQueueGroup::lazyPush | ( | $jobs | ) |
Buffer jobs for insertion via push() or call it now if in CLI mode.
IJobSpecification | IJobSpecification[] | $jobs | A single Job or a list of Jobs |
Definition at line 185 of file JobQueueGroup.php.
References push().
JobQueueGroup::pop | ( | $qtype = self::TYPE_DEFAULT, | |
$flags = 0, | |||
array | $ignored = [] ) |
Pop one job off a job queue.
This pops a job off a queue as specified by $wgJobTypeConf and updates the aggregate job queue information cache as needed.
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 |
JobQueueError |
Definition at line 213 of file JobQueueGroup.php.
References $job, getDefaultQueueTypes(), getQueuesWithJobs(), and pop().
Referenced by pop().
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.
IJobSpecification | IJobSpecification[] | $jobs | A single Job or a list of Jobs |
Definition at line 127 of file JobQueueGroup.php.
References $job, push(), and MapCacheLRU\set().
Referenced by lazyPush(), and push().
JobQueueGroup::queuesHaveJobs | ( | $type = self::TYPE_ANY | ) |
Check if there are any queues with jobs (this is cached)
int | $type | JobQueueGroup::TYPE_* constant |
Definition at line 333 of file JobQueueGroup.php.
References MapCacheLRU\get(), getDefaultQueueTypes(), and getQueuesWithJobs().
JobQueueGroup::waitForBackups | ( | ) |
Wait for any replica DBs or backup queue servers to catch up.
This does nothing for certain queue classes.
Definition at line 291 of file JobQueueGroup.php.
References waitForBackups(), and wfDeprecated().
Referenced by waitForBackups().
|
protected |
Definition at line 36 of file JobQueueGroup.php.
|
protected |
Map of (bucket => (queue => JobQueue, types => list of types)
Definition at line 56 of file JobQueueGroup.php.
|
protected |
Wiki domain ID.
Definition at line 39 of file JobQueueGroup.php.
|
protected |
Read only mode.
Definition at line 41 of file JobQueueGroup.php.
const JobQueueGroup::TYPE_DEFAULT = 1 |
Definition at line 58 of file JobQueueGroup.php.
const JobQueueGroup::USE_CACHE = 1 |
Definition at line 61 of file JobQueueGroup.php.