Go to the documentation of this file.
23 use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
60 $this->
type = $params[
'type'];
61 $this->claimTTL =
$params[
'claimTTL'] ?? 0;
62 $this->maxTries =
$params[
'maxTries'] ?? 3;
64 $this->order =
$params[
'order'];
69 throw new JobQueueError( __CLASS__ .
" does not support '{$this->order}' order." );
71 $this->readOnlyReason =
$params[
'readOnlyReason'] ??
false;
108 if ( !class_exists( $class ) ) {
109 throw new JobQueueError(
"Invalid job queue class '$class'." );
112 if ( !( $obj instanceof
self ) ) {
113 throw new JobQueueError(
"Class '$class' is not a " . __CLASS__ .
" class." );
310 final public function push( $jobs, $flags = 0 ) {
311 $jobs = is_array( $jobs ) ? $jobs : [ $jobs ];
328 if ( $jobs === [] ) {
332 foreach ( $jobs
as $job ) {
335 "Got '{$job->getType()}' job; expected a '{$this->type}' job." );
338 "Got delayed '{$job->getType()}' job; delays are not supported." );
344 foreach ( $jobs
as $job ) {
345 if (
$job->isRootJob() ) {
366 final public function pop() {
377 }
catch ( Exception
$e ) {
388 abstract protected function doPop();
403 throw new JobQueueError(
"Got '{$job->getType()}' job; expected '{$this->type}'." );
406 $this->
doAck( $job );
449 throw new JobQueueError(
"Got '{$job->getType()}' job; expected '{$this->type}'." );
462 if ( !
$job->hasRootJobParams() ) {
463 throw new JobQueueError(
"Cannot register root job; missing parameters." );
473 $timestamp = $this->dupCache->get( $key );
474 if ( $timestamp && $timestamp >=
$params[
'rootJobTimestamp'] ) {
479 return $this->dupCache->set( $key,
$params[
'rootJobTimestamp'], self::ROOTJOB_TTL );
491 throw new JobQueueError(
"Got '{$job->getType()}' job; expected '{$this->type}'." );
504 if ( !
$job->hasRootJobParams() ) {
511 $timestamp = $this->dupCache->get( $key );
514 return ( $timestamp && $timestamp >
$params[
'rootJobTimestamp'] );
522 return $this->dupCache->makeGlobalKey(
538 final public function delete() {
549 throw new JobQueueError(
"This method is not implemented." );
606 return new ArrayIterator( [] );
620 return new ArrayIterator( [] );
631 return new ArrayIterator( [] );
693 if ( $this->readOnlyReason !==
false ) {
707 $this->stats->updateCount(
"jobqueue.{$key}.all", $delta );
708 $this->stats->updateCount(
"jobqueue.{$key}.{$type}", $delta );
isEmpty()
Quickly check if the queue has no available (unacquired, non-delayed) jobs.
optimalOrder()
Get the default queue order to use if configuration does not specify one.
getAllDelayedJobs()
Get an iterator to traverse over all delayed jobs in this queue.
int $claimTTL
Time to live in seconds.
A BagOStuff object with no objects in it.
batchPush(array $jobs, $flags=0)
Push a batch of jobs into the queue.
incrStats( $key, $type, $delta=1)
Call wfIncrStats() for the queue overall and for the queue type.
doGetSiblingQueuesWithJobs(array $types)
Class representing a cache/ephemeral data store.
string bool $readOnlyReason
Read only rationale (or false if r/w)
doBatchPush(array $jobs, $flags)
deduplicateRootJob(IJobSpecification $job)
Register the "root job" of a given job into the queue for de-duplication.
push( $jobs, $flags=0)
Push one or more jobs into the queue.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
getAbandonedCount()
Get the number of acquired jobs that can no longer be attempted.
Class to both describe a background job and handle jobs.
getAcquiredCount()
Get the number of acquired jobs (these are temporarily out of the queue).
doGetSiblingQueueSizes(array $types)
ack(Job $job)
Acknowledge that a job was completed.
doIsRootJobOldDuplicate(Job $job)
static getWikiIdFromDbDomain( $domain)
Get the wiki ID of a database domain.
supportedOrders()
Get the allowed queue orders for configuration validation.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
getDelayedCount()
Get the number of delayed jobs (these are temporarily out of the queue).
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static newFromJob(Job $job)
Get a duplicate no-op version of a job.
getSize()
Get the number of available (unacquired, non-delayed) jobs in the queue.
getAllQueuedJobs()
Get an iterator to traverse over all available jobs in this queue.
StatsdDataFactoryInterface $stats
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
waitForBackups()
Wait for any replica DBs or backup servers to catch up.
static factory(array $params)
Get a job queue object of the specified type.
supportsDelayedJobs()
Find out if delayed jobs are supported for configuration validation.
string $order
Job priority for pop()
getAllAcquiredJobs()
Get an iterator to traverse over all claimed jobs in this queue.
getRootJobCacheKey( $signature)
if(count( $args)< 1) $job
flushCaches()
Clear any process and persistent caches.
int $maxTries
Maximum number of times to try a job.
pop()
Pop a job off of the queue.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Class to handle enqueueing and running of background jobs.
getCoalesceLocationInternal()
Do not use this function outside of JobQueue/JobQueueGroup.
isRootJobOldDuplicate(Job $job)
Check if the "root" job of a given job has been superseded by a newer one.
getAllAbandonedJobs()
Get an iterator to traverse over all abandoned jobs in this queue.
string $domain
DB domain ID.
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
getSiblingQueueSizes(array $types)
Check the size of each of the given queues.
getSiblingQueuesWithJobs(array $types)
Check whether each of the given queues are empty.
Job queue task description interface.
doDeduplicateRootJob(IJobSpecification $job)
__construct(array $params)