MediaWiki
master
|
Class to handle enqueueing and running of background jobs. More...
Public Member Functions | |
ack (RunnableJob $job) | |
Acknowledge that a job was completed. More... | |
batchPush (array $jobs, $flags=0) | |
Push a batch of jobs into the queue. More... | |
deduplicateRootJob (IJobSpecification $job) | |
Register the "root job" of a given job into the queue for de-duplication. More... | |
delayedJobsEnabled () | |
delete () | |
Deleted all unclaimed and delayed jobs from the queue. More... | |
flushCaches () | |
Clear any process and persistent caches. More... | |
getAbandonedCount () | |
Get the number of acquired jobs that can no longer be attempted. More... | |
getAcquiredCount () | |
Get the number of acquired jobs (these are temporarily out of the queue). More... | |
getAllAbandonedJobs () | |
Get an iterator to traverse over all abandoned jobs in this queue. More... | |
getAllAcquiredJobs () | |
Get an iterator to traverse over all claimed jobs in this queue. More... | |
getAllDelayedJobs () | |
Get an iterator to traverse over all delayed jobs in this queue. More... | |
getAllQueuedJobs () | |
Get an iterator to traverse over all available jobs in this queue. More... | |
getCoalesceLocationInternal () | |
Do not use this function outside of JobQueue/JobQueueGroup. More... | |
getDelayedCount () | |
Get the number of delayed jobs (these are temporarily out of the queue). More... | |
getDomain () | |
getOrder () | |
getReadOnlyReason () | |
getSiblingQueueSizes (array $types) | |
Check the size of each of the given queues. More... | |
getSiblingQueuesWithJobs (array $types) | |
Check whether each of the given queues are empty. More... | |
getSize () | |
Get the number of available (unacquired, non-delayed) jobs in the queue. More... | |
getType () | |
getWiki () | |
isEmpty () | |
Quickly check if the queue has no available (unacquired, non-delayed) jobs. More... | |
pop () | |
Pop a job off of the queue. More... | |
push ( $jobs, $flags=0) | |
Push one or more jobs into the queue. More... | |
waitForBackups () | |
Wait for any replica DBs or backup servers to catch up. More... | |
Static Public Member Functions | |
static | factory (array $params) |
Get a job queue object of the specified type. More... | |
Public Attributes | |
const | QOS_ATOMIC = 1 |
const | ROOTJOB_TTL = 2419200 |
Protected Member Functions | |
__construct (array $params) | |
assertNotReadOnly () | |
doAck (RunnableJob $job) | |
doBatchPush (array $jobs, $flags) | |
doDeduplicateRootJob (IJobSpecification $job) | |
doDelete () | |
doFlushCaches () | |
doGetAbandonedCount () | |
doGetAcquiredCount () | |
doGetDelayedCount () | |
doGetSiblingQueueSizes (array $types) | |
doGetSiblingQueuesWithJobs (array $types) | |
doGetSize () | |
doIsEmpty () | |
doIsRootJobOldDuplicate (IJobSpecification $job) | |
doPop () | |
doWaitForBackups () | |
factoryJob ( $command, $params) | |
getRootJobCacheKey ( $signature) | |
incrStats ( $key, $type, $delta=1) | |
Call wfIncrStats() for the queue overall and for the queue type. More... | |
isRootJobOldDuplicate (IJobSpecification $job) | |
Check if the "root" job of a given job has been superseded by a newer one. More... | |
optimalOrder () | |
Get the default queue order to use if configuration does not specify one. More... | |
supportedOrders () | |
Get the allowed queue orders for configuration validation. More... | |
supportsDelayedJobs () | |
Find out if delayed jobs are supported for configuration validation. More... | |
Protected Attributes | |
int | $claimTTL |
Time to live in seconds. More... | |
string | $domain |
DB domain ID. More... | |
int | $maxTries |
Maximum number of times to try a job. More... | |
string | $order |
Job priority for pop() More... | |
string bool | $readOnlyReason |
Read only rationale (or false if r/w) More... | |
StatsdDataFactoryInterface | $stats |
string | $type |
Job type. More... | |
WANObjectCache | $wanCache |
Class to handle enqueueing and running of background jobs.
See the architecture doc for more information.
Definition at line 33 of file JobQueue.php.
|
protected |
array | $params |
|
JobQueueError |
Definition at line 68 of file JobQueue.php.
References WANObjectCache\newEmpty(), optimalOrder(), and supportedOrders().
|
final |
Acknowledge that a job was completed.
This does nothing for certain queue classes or if "claimTTL" is not set. Outside callers should use JobQueueGroup::ack() instead of this function.
RunnableJob | $job |
JobQueueError |
Definition at line 410 of file JobQueue.php.
References $job, $type, assertNotReadOnly(), doAck(), and IJobSpecification\getType().
|
protected |
JobQueueReadOnlyError |
Definition at line 714 of file JobQueue.php.
Referenced by ack(), batchPush(), deduplicateRootJob(), delete(), and pop().
|
final |
Push a batch of jobs into the queue.
This does not require $wgJobClasses to be set for the given job type. Outside callers should use JobQueueGroup::push() instead of this function.
IJobSpecification[] | $jobs | |
int | $flags | Bitfield (supports JobQueue::QOS_ATOMIC) |
JobQueueError |
Definition at line 335 of file JobQueue.php.
References $job, $type, assertNotReadOnly(), deduplicateRootJob(), doBatchPush(), and supportsDelayedJobs().
Referenced by push().
|
final |
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. This is used to turn older, duplicate, job entries into no-ops. The root job information will remain in the registry until it simply falls out of cache.
This requires that $job has two special fields in the "params" array:
A "root job" is a conceptual job that consist of potentially many smaller jobs that are actually inserted into the queue. For example, "refreshLinks" jobs are spawned when a template is edited. One can think of the task as "update links of pages that use template X" and an instance of that task as a "root job". However, what actually goes into the queue are range and leaf job subtypes. Since these jobs include things like page ID ranges and DB master positions, and can morph into smaller jobs recursively, simple duplicate detection for individual jobs being identical (like that of job_sha1) is not useful.
In the case of "refreshLinks", if these jobs are still in the queue when the template is edited again, we want all of these old refreshLinks jobs for that template to become no-ops. This can greatly reduce server load, since refreshLinks jobs involves parsing. Essentially, the new batch of jobs belong to a new "root job" and the older ones to a previous "root job" for the same task of "update links of pages that use template X".
This does nothing for certain queue classes.
IJobSpecification | $job |
JobQueueError |
Definition at line 456 of file JobQueue.php.
References $type, assertNotReadOnly(), doDeduplicateRootJob(), and IJobSpecification\getType().
Referenced by batchPush().
|
final |
Definition at line 185 of file JobQueue.php.
References supportsDelayedJobs().
|
final |
Deleted all unclaimed and delayed jobs from the queue.
JobQueueError |
Definition at line 550 of file JobQueue.php.
References assertNotReadOnly(), and doDelete().
|
abstractprotected |
|
abstractprotected |
IJobSpecification[] | $jobs | |
int | $flags |
Referenced by batchPush().
|
protected |
IJobSpecification | $job |
JobQueueError |
Definition at line 471 of file JobQueue.php.
References getRootJobCacheKey(), IJobSpecification\getRootJobParams(), and IJobSpecification\hasRootJobParams().
Referenced by deduplicateRootJob().
|
protected |
JobQueueError |
Definition at line 560 of file JobQueue.php.
Referenced by delete().
|
protected |
Definition at line 596 of file JobQueue.php.
References getAllQueuedJobs().
Referenced by flushCaches().
|
protected |
Definition at line 306 of file JobQueue.php.
Referenced by getAbandonedCount().
|
abstractprotected |
|
protected |
Definition at line 283 of file JobQueue.php.
Referenced by getDelayedCount().
|
protected |
array | $types | List of queues types |
Definition at line 697 of file JobQueue.php.
Referenced by getSiblingQueueSizes().
|
protected |
array | $types | List of queues types |
Definition at line 674 of file JobQueue.php.
Referenced by getSiblingQueuesWithJobs().
|
abstractprotected |
|
abstractprotected |
|
protected |
IJobSpecification | $job |
Definition at line 511 of file JobQueue.php.
References getRootJobCacheKey(), IJobSpecification\getRootJobParams(), and IJobSpecification\hasRootJobParams().
Referenced by isRootJobOldDuplicate().
|
abstractprotected |
|
protected |
Definition at line 580 of file JobQueue.php.
Referenced by waitForBackups().
|
staticfinal |
Get a job queue object of the specified type.
$params includes:
Queue classes should throw an exception if they do not support the options given.
array | $params |
JobQueueError |
Definition at line 116 of file JobQueue.php.
Referenced by JobQueueFederated\__construct(), CopyJobQueue\execute(), JobQueueGroup\get(), and JobQueueGroup\getCoalescedQueues().
|
protected |
string | $command | |
array | $params |
Definition at line 706 of file JobQueue.php.
References $command, and Job\factory().
Referenced by JobQueueRedis\getJobFromFields(), JobQueueRedis\getJobFromUidInternal(), JobQueueDB\jobFromRow(), and JobQueueMemory\jobFromSpecInternal().
|
final |
Clear any process and persistent caches.
Definition at line 588 of file JobQueue.php.
References doFlushCaches().
|
final |
Get the number of acquired jobs that can no longer be attempted.
Queue classes should use caching if they are any slower without memcached.
If caching is used, this number might be out of date for a minute.
JobQueueError |
Definition at line 296 of file JobQueue.php.
References $res, and doGetAbandonedCount().
|
final |
Get the number of acquired jobs (these are temporarily out of the queue).
Queue classes should use caching if they are any slower without memcached.
If caching is used, this number might be out of date for a minute.
JobQueueError |
Definition at line 251 of file JobQueue.php.
References $res, and doGetAcquiredCount().
Referenced by JobQueueMemory\doAck().
JobQueue::getAllAbandonedJobs | ( | ) |
Get an iterator to traverse over all abandoned jobs in this queue.
JobQueueError |
Definition at line 642 of file JobQueue.php.
Referenced by ManageJobs\repushAbandoned().
JobQueue::getAllAcquiredJobs | ( | ) |
Get an iterator to traverse over all claimed jobs in this queue.
Callers should be quick to iterator over it or few results will be returned due to jobs being acknowledged and deleted
JobQueueError |
Definition at line 631 of file JobQueue.php.
JobQueue::getAllDelayedJobs | ( | ) |
Get an iterator to traverse over all delayed jobs in this queue.
Note: results may be stale if the queue is concurrently modified.
JobQueueError |
Definition at line 617 of file JobQueue.php.
|
abstract |
Get an iterator to traverse over all available jobs in this queue.
This does not include jobs that are currently acquired or delayed. Note: results may be stale if the queue is concurrently modified.
JobQueueError |
Referenced by doFlushCaches().
JobQueue::getCoalesceLocationInternal | ( | ) |
Do not use this function outside of JobQueue/JobQueueGroup.
Definition at line 652 of file JobQueue.php.
|
final |
Get the number of delayed jobs (these are temporarily out of the queue).
Queue classes should use caching if they are any slower without memcached.
If caching is used, this number might be out of date for a minute.
JobQueueError |
Definition at line 273 of file JobQueue.php.
References $res, and doGetDelayedCount().
|
final |
Definition at line 132 of file JobQueue.php.
References $domain.
Referenced by ManageJobs\repushAbandoned().
|
final |
Definition at line 154 of file JobQueue.php.
References $order, optimalOrder(), and supportedOrders().
JobQueue::getReadOnlyReason | ( | ) |
Definition at line 193 of file JobQueue.php.
References $readOnlyReason.
|
protected |
string | $signature | Hash identifier of the root job |
Definition at line 533 of file JobQueue.php.
Referenced by JobQueueRedis\doDeduplicateRootJob(), doDeduplicateRootJob(), JobQueueRedis\doIsRootJobOldDuplicate(), and doIsRootJobOldDuplicate().
|
final |
Check the size of each of the given queues.
For queues not served by the same store as this one, 0 is returned. This is used for batching checks for queues stored at the same place.
array | $types | List of queues types |
JobQueueError |
Definition at line 688 of file JobQueue.php.
References doGetSiblingQueueSizes().
|
final |
Check whether each of the given queues are empty.
This is used for batching checks for queues stored at the same place.
array | $types | List of queues types |
JobQueueError |
Definition at line 665 of file JobQueue.php.
References doGetSiblingQueuesWithJobs().
|
final |
Get the number of available (unacquired, non-delayed) jobs in the queue.
Queue classes should use caching if they are any slower without memcached.
If caching is used, this number might be out of date for a minute.
JobQueueError |
Definition at line 230 of file JobQueue.php.
References $res, and doGetSize().
|
final |
Definition at line 147 of file JobQueue.php.
References $type.
Referenced by JobQueueDB\getAllAcquiredJobs(), JobQueueDB\getAllQueuedJobs(), and ManageJobs\repushAbandoned().
|
final |
Definition at line 140 of file JobQueue.php.
References WikiMap\getWikiIdFromDbDomain().
|
protected |
Call wfIncrStats() for the queue overall and for the queue type.
string | $key | Event type |
string | $type | Job type |
int | $delta |
Definition at line 728 of file JobQueue.php.
Referenced by JobQueueRedis\doAck(), JobQueueDB\doAck(), JobQueueRedis\doBatchPush(), JobQueueDB\doBatchPushInternal(), JobQueueDB\doPop(), JobQueueRedis\doPop(), pop(), and JobQueueDB\recycleAndDeleteStaleJobs().
|
final |
Quickly check if the queue has no available (unacquired, non-delayed) jobs.
Queue classes should use caching if they are any slower without memcached.
If caching is used, this might return false when there are actually no jobs. If pop() is called and returns false then it should correct the cache. Also, calling flushCaches() first prevents this. However, this affect is typically not distinguishable from the race condition between isEmpty() and pop().
JobQueueError |
Definition at line 209 of file JobQueue.php.
References $res, and doIsEmpty().
|
finalprotected |
Check if the "root" job of a given job has been superseded by a newer one.
IJobSpecification | $job |
JobQueueError |
Definition at line 498 of file JobQueue.php.
References $type, doIsRootJobOldDuplicate(), and IJobSpecification\getType().
Referenced by pop().
|
abstractprotected |
Get the default queue order to use if configuration does not specify one.
Referenced by __construct(), and getOrder().
|
final |
Pop a job off of the queue.
This requires $wgJobClasses to be set for the given job type. Outside callers should use JobQueueGroup::pop() instead of this function.
JobQueueError |
Definition at line 376 of file JobQueue.php.
References $job, assertNotReadOnly(), doPop(), incrStats(), isRootJobOldDuplicate(), and DuplicateJob\newFromJob().
|
final |
Push one or more jobs into the queue.
This does not require $wgJobClasses to be set for the given job type. Outside callers should use JobQueueGroup::push() instead of this function.
IJobSpecification|IJobSpecification[] | $jobs | |
int | $flags | Bitfield (supports JobQueue::QOS_ATOMIC) |
JobQueueError |
Definition at line 320 of file JobQueue.php.
References batchPush().
Referenced by CopyJobQueue\copyJobs(), and ManageJobs\repushAbandoned().
|
abstractprotected |
Get the allowed queue orders for configuration validation.
Referenced by __construct(), and getOrder().
|
protected |
Find out if delayed jobs are supported for configuration validation.
Definition at line 177 of file JobQueue.php.
Referenced by batchPush(), and delayedJobsEnabled().
|
final |
Wait for any replica DBs or backup servers to catch up.
This does nothing for certain queue classes.
JobQueueError |
Definition at line 572 of file JobQueue.php.
References doWaitForBackups().
Referenced by CopyJobQueue\copyJobs(), and ManageJobs\repushAbandoned().
|
protected |
Time to live in seconds.
Definition at line 41 of file JobQueue.php.
|
protected |
DB domain ID.
Definition at line 35 of file JobQueue.php.
Referenced by JobQueueFederated\__construct(), getDomain(), and JobQueueMemory\getQueueData().
|
protected |
Maximum number of times to try a job.
Definition at line 43 of file JobQueue.php.
|
protected |
|
protected |
Read only rationale (or false if r/w)
Definition at line 45 of file JobQueue.php.
Referenced by getReadOnlyReason().
|
protected |
Definition at line 47 of file JobQueue.php.
|
protected |
Job type.
Definition at line 37 of file JobQueue.php.
Referenced by ack(), batchPush(), JobQueueDB\claimRandom(), deduplicateRootJob(), JobQueueDB\doFlushCaches(), JobQueueFederated\doGetSiblingQueueSizes(), JobQueueRedis\doGetSiblingQueueSizes(), JobQueueMemory\getQueueData(), JobQueueRedis\getQueueKey(), getType(), isRootJobOldDuplicate(), and JobQueueDB\recycleAndDeleteStaleJobs().
|
protected |
Definition at line 50 of file JobQueue.php.
const JobQueue::QOS_ATOMIC = 1 |
Definition at line 52 of file JobQueue.php.
const JobQueue::ROOTJOB_TTL = 2419200 |
Definition at line 54 of file JobQueue.php.