MediaWiki REL1_31
JobQueueDBSingle Class Reference
Inheritance diagram for JobQueueDBSingle:
Collaboration diagram for JobQueueDBSingle:

Protected Member Functions

 getDB ( $index)
 
- Protected Member Functions inherited from JobQueueDB
 __construct (array $params)
 Additional parameters include:
 
 claimOldest ( $uuid)
 Reserve a row with a single UPDATE without holding row locks over RTTs...
 
 claimRandom ( $uuid, $rand, $gte)
 Reserve a row with a single UPDATE without holding row locks over RTTs...
 
 doAck (Job $job)
 
 doBatchPush (array $jobs, $flags)
 
 doDeduplicateRootJob (IJobSpecification $job)
 
 doDelete ()
 
 doFlushCaches ()
 
 doGetAbandonedCount ()
 
 doGetAcquiredCount ()
 
 doGetSiblingQueueSizes (array $types)
 
 doGetSiblingQueuesWithJobs (array $types)
 
 doGetSize ()
 
 doIsEmpty ()
 
 doPop ()
 
 doWaitForBackups ()
 
 getJobIterator (array $conds)
 
 getMasterDB ()
 
 getReplicaDB ()
 
 insertFields (IJobSpecification $job)
 
 optimalOrder ()
 Get the default queue order to use if configuration does not specify one.
 
 supportedOrders ()
 Get the allowed queue orders for configuration validation.
 
 throwDBException (DBError $e)
 
- Protected Member Functions inherited from JobQueue
 assertNotReadOnly ()
 
 doGetDelayedCount ()
 
 doIsRootJobOldDuplicate (Job $job)
 
 getRootJobCacheKey ( $signature)
 
 isRootJobOldDuplicate (Job $job)
 Check if the "root" job of a given job has been superseded by a newer one.
 
 supportsDelayedJobs ()
 Find out if delayed jobs are supported for configuration validation.
 

Additional Inherited Members

- Public Member Functions inherited from JobQueueDB
 doBatchPushInternal (IDatabase $dbw, array $jobs, $flags, $method)
 This function should not be called outside of JobQueueDB.
 
 getAllAbandonedJobs ()
 
 getAllAcquiredJobs ()
 
 getAllQueuedJobs ()
 
 getCoalesceLocationInternal ()
 Do not use this function outside of JobQueue/JobQueueGroup.
 
 recycleAndDeleteStaleJobs ()
 Recycle or destroy any jobs that have been claimed for too long.
 
- Public Member Functions inherited from JobQueue
 ack (Job $job)
 Acknowledge that a job was completed.
 
 batchPush (array $jobs, $flags=0)
 Push a batch of jobs into the queue.
 
 deduplicateRootJob (IJobSpecification $job)
 Register the "root job" of a given job into the queue for de-duplication.
 
 delayedJobsEnabled ()
 
 delete ()
 Deleted all unclaimed and delayed jobs from the queue.
 
 flushCaches ()
 Clear any process and persistent caches.
 
 getAbandonedCount ()
 Get the number of acquired jobs that can no longer be attempted.
 
 getAcquiredCount ()
 Get the number of acquired jobs (these are temporarily out of the queue).
 
 getAllDelayedJobs ()
 Get an iterator to traverse over all delayed jobs in this queue.
 
 getDelayedCount ()
 Get the number of delayed jobs (these are temporarily out of the queue).
 
 getOrder ()
 
 getReadOnlyReason ()
 
 getSiblingQueueSizes (array $types)
 Check the size of each of the given queues.
 
 getSiblingQueuesWithJobs (array $types)
 Check whether each of the given queues are empty.
 
 getSize ()
 Get the number of available (unacquired, non-delayed) jobs in the queue.
 
 getType ()
 
 getWiki ()
 
 isEmpty ()
 Quickly check if the queue has no available (unacquired, non-delayed) jobs.
 
 pop ()
 Pop a job off of the queue.
 
 push ( $jobs, $flags=0)
 Push one or more jobs into the queue.
 
 waitForBackups ()
 Wait for any replica DBs or backup servers to catch up.
 
- Static Public Member Functions inherited from JobQueueDB
static selectFields ()
 Return the list of job fields that should be selected.
 
- Static Public Member Functions inherited from JobQueue
static factory (array $params)
 Get a job queue object of the specified type.
 
static incrStats ( $key, $type, $delta=1)
 Call wfIncrStats() for the queue overall and for the queue type.
 
- Public Attributes inherited from JobQueueDB
const CACHE_TTL_SHORT = 30
 
const MAX_AGE_PRUNE = 604800
 
const MAX_JOB_RANDOM = 2147483647
 
const MAX_OFFSET = 255
 
- Public Attributes inherited from JobQueue
const QOS_ATOMIC = 1
 
const ROOTJOB_TTL = 2419200
 
- Static Protected Member Functions inherited from JobQueueDB
static extractBlob ( $blob)
 
static makeBlob ( $params)
 
- Protected Attributes inherited from JobQueueDB
WANObjectCache $cache
 
bool string $cluster = false
 Name of an external DB cluster.
 
- Protected Attributes inherited from JobQueue
JobQueueAggregator $aggr
 
int $claimTTL
 Time to live in seconds.
 
BagOStuff $dupCache
 
int $maxTries
 Maximum number of times to try a job.
 
string $order
 Job priority for pop()
 
string bool $readOnlyReason
 Read only rationale (or false if r/w)
 
string $type
 Job type.
 
string $wiki
 Wiki ID.
 

Detailed Description

Definition at line 387 of file JobQueueTest.php.

Member Function Documentation

◆ getDB()

JobQueueDBSingle::getDB ( $index)
protected
Parameters
int$index(DB_REPLICA/DB_MASTER)
Returns
DBConnRef

Reimplemented from JobQueueDB.

Definition at line 388 of file JobQueueTest.php.


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