MediaWiki  REL1_31
JobQueueMemory Class Reference

Class to handle job queues stored in PHP memory for testing. More...

Inheritance diagram for JobQueueMemory:
Collaboration diagram for JobQueueMemory:

Public Member Functions

 getAllAcquiredJobs ()
 
 getAllQueuedJobs ()
 
 jobFromSpecInternal (IJobSpecification $spec)
 
- Public Member Functions inherited from JobQueue
 ack (Job $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...
 
 getAllDelayedJobs ()
 Get an iterator to traverse over all delayed 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...
 
 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...
 

Protected Member Functions

 doAck (Job $job)
 
 doBatchPush (array $jobs, $flags)
 
 doDelete ()
 
 doGetAcquiredCount ()
 
 doGetSize ()
 
 doIsEmpty ()
 
 doPop ()
 
 optimalOrder ()
 
 supportedOrders ()
 
- Protected Member Functions inherited from JobQueue
 __construct (array $params)
 
 assertNotReadOnly ()
 
 doDeduplicateRootJob (IJobSpecification $job)
 
 doFlushCaches ()
 
 doGetAbandonedCount ()
 
 doGetDelayedCount ()
 
 doGetSiblingQueueSizes (array $types)
 
 doGetSiblingQueuesWithJobs (array $types)
 
 doIsRootJobOldDuplicate (Job $job)
 
 doWaitForBackups ()
 
 getRootJobCacheKey ( $signature)
 
 isRootJobOldDuplicate (Job $job)
 Check if the "root" job of a given job has been superseded by a newer one. More...
 
 supportsDelayedJobs ()
 Find out if delayed jobs are supported for configuration validation. More...
 

Static Protected Attributes

static array[] $data = []
 

Private Member Functions

getQueueData ( $field, $init=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from JobQueue
static factory (array $params)
 Get a job queue object of the specified type. More...
 
static incrStats ( $key, $type, $delta=1)
 Call wfIncrStats() for the queue overall and for the queue type. More...
 
- Public Attributes inherited from JobQueue
const QOS_ATOMIC = 1
 
const ROOTJOB_TTL = 2419200
 
- Protected Attributes inherited from JobQueue
JobQueueAggregator $aggr
 
int $claimTTL
 Time to live in seconds. More...
 
BagOStuff $dupCache
 
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...
 
string $type
 Job type. More...
 
string $wiki
 Wiki ID. More...
 

Detailed Description

Class to handle job queues stored in PHP memory for testing.

JobQueueGroup does not remember every queue instance, so statically track it here

Since
1.27

Definition at line 31 of file JobQueueMemory.php.

Member Function Documentation

◆ doAck()

JobQueueMemory::doAck ( Job  $job)
protected
See also
JobQueue::doAck
Parameters
Job$job

Reimplemented from JobQueue.

Definition at line 145 of file JobQueueMemory.php.

References $job, JobQueue\getAcquiredCount(), and getQueueData().

◆ doBatchPush()

JobQueueMemory::doBatchPush ( array  $jobs,
  $flags 
)
protected
See also
JobQueue::doBatchPush
Parameters
IJobSpecification[]$jobs
int$flags

Reimplemented from JobQueue.

Definition at line 41 of file JobQueueMemory.php.

References $job, as, getQueueData(), and serialize().

◆ doDelete()

JobQueueMemory::doDelete ( )
protected
See also
JobQueue::doDelete

Reimplemented from JobQueue.

Definition at line 157 of file JobQueueMemory.php.

References type, and wiki.

◆ doGetAcquiredCount()

JobQueueMemory::doGetAcquiredCount ( )
protected
See also
JobQueue::doGetAcquiredCount
Returns
int

Reimplemented from JobQueue.

Definition at line 102 of file JobQueueMemory.php.

References getQueueData().

◆ doGetSize()

JobQueueMemory::doGetSize ( )
protected
See also
JobQueue::doGetSize
Returns
int

Reimplemented from JobQueue.

Definition at line 91 of file JobQueueMemory.php.

References getQueueData().

Referenced by doIsEmpty(), and doPop().

◆ doIsEmpty()

JobQueueMemory::doIsEmpty ( )
protected
See also
JobQueue::doIsEmpty
Returns
bool

Reimplemented from JobQueue.

Definition at line 82 of file JobQueueMemory.php.

References doGetSize().

◆ doPop()

JobQueueMemory::doPop ( )
protected
See also
JobQueue::doPop
Returns
Job|bool

Reimplemented from JobQueue.

Definition at line 113 of file JobQueueMemory.php.

References $job, doGetSize(), getQueueData(), jobFromSpecInternal(), key, and order.

◆ getAllAcquiredJobs()

JobQueueMemory::getAllAcquiredJobs ( )
See also
JobQueue::getAllAcquiredJobs
Returns
Iterator of Job objects.

Reimplemented from JobQueue.

Definition at line 190 of file JobQueueMemory.php.

References $value, getQueueData(), and jobFromSpecInternal().

◆ getAllQueuedJobs()

JobQueueMemory::getAllQueuedJobs ( )
See also
JobQueue::getAllQueuedJobs
Returns
Iterator of Job objects.

Reimplemented from JobQueue.

Definition at line 171 of file JobQueueMemory.php.

References $value, getQueueData(), and jobFromSpecInternal().

◆ getQueueData()

& JobQueueMemory::getQueueData (   $field,
  $init = null 
)
private
Parameters
string$field
mixed$init
Returns
mixed

Definition at line 219 of file JobQueueMemory.php.

References JobQueue\$type, JobQueue\$wiki, type, and wiki.

Referenced by doAck(), doBatchPush(), doGetAcquiredCount(), doGetSize(), doPop(), getAllAcquiredJobs(), and getAllQueuedJobs().

◆ jobFromSpecInternal()

JobQueueMemory::jobFromSpecInternal ( IJobSpecification  $spec)

◆ optimalOrder()

JobQueueMemory::optimalOrder ( )
protected
See also
JobQueue::optimalOrder
Returns
string

Reimplemented from JobQueue.

Definition at line 73 of file JobQueueMemory.php.

◆ supportedOrders()

JobQueueMemory::supportedOrders ( )
protected
See also
JobQueue::supportedOrders
Returns
string[]

Reimplemented from JobQueue.

Definition at line 64 of file JobQueueMemory.php.

Member Data Documentation

◆ $data

array [] JobQueueMemory::$data = []
staticprotected

Definition at line 33 of file JobQueueMemory.php.


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