MediaWiki  1.23.0
Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
JobQueueAggregatorMemc Class Reference
JobQueue

Class to handle tracking information about all queues using BagOStuff. More...

Inheritance diagram for JobQueueAggregatorMemc:
Inheritance graph
[legend]
Collaboration diagram for JobQueueAggregatorMemc:
Collaboration graph
[legend]

Protected Member Functions

 __construct (array $params)
 @params include: More...
 
 doGetAllReadyWikiQueues ()
 
 doNotifyQueueEmpty ( $wiki, $type)
 
 doNotifyQueueNonEmpty ( $wiki, $type)
 
 doPurge ()
 
- Protected Member Functions inherited from JobQueueAggregator
 findPendingWikiQueues ()
 Get all databases that have a pending job. More...
 

Protected Attributes

BagOStuff $cache
 
 $cacheTTL
 

Private Member Functions

 getReadyQueueCacheKey ()
 

Additional Inherited Members

- Public Member Functions inherited from JobQueueAggregator
 getAllReadyWikiQueues ()
 Get the list of all of the queues with jobs. More...
 
 notifyQueueEmpty ( $wiki, $type)
 Mark a queue as being empty. More...
 
 notifyQueueNonEmpty ( $wiki, $type)
 Mark a queue as being non-empty. More...
 
 purge ()
 Purge all of the aggregator information. More...
 
- Static Public Member Functions inherited from JobQueueAggregator
static destroySingleton ()
 Destroy the singleton instance. More...
 
static singleton ()
 
- Static Protected Attributes inherited from JobQueueAggregator
static $instance = null
 

Detailed Description

Class to handle tracking information about all queues using BagOStuff.

Since
1.21

Definition at line 30 of file JobQueueAggregatorMemc.php.

Constructor & Destructor Documentation

◆ __construct()

JobQueueAggregatorMemc::__construct ( array  $params)
protected

@params include:

  • objectCache : Name of an object cache registered in $wgObjectCaches. This defaults to the one specified by $wgMainCacheType.
  • cacheTTL : Seconds to cache the aggregate data before regenerating.
    Parameters
    array$params

Reimplemented from JobQueueAggregator.

Definition at line 42 of file JobQueueAggregatorMemc.php.

References $params, cache, wfGetCache(), and wfGetMainCache().

Member Function Documentation

◆ doGetAllReadyWikiQueues()

JobQueueAggregatorMemc::doGetAllReadyWikiQueues ( )
protected
See also
JobQueueAggregator::doAllGetReadyWikiQueues()

Reimplemented from JobQueueAggregator.

Definition at line 81 of file JobQueueAggregatorMemc.php.

References array(), cache, JobQueueAggregator\findPendingWikiQueues(), and getReadyQueueCacheKey().

◆ doNotifyQueueEmpty()

JobQueueAggregatorMemc::doNotifyQueueEmpty (   $wiki,
  $type 
)
protected
See also
JobQueueAggregator::doNotifyQueueEmpty()

Reimplemented from JobQueueAggregator.

Definition at line 53 of file JobQueueAggregatorMemc.php.

References $type, array(), cache, and getReadyQueueCacheKey().

◆ doNotifyQueueNonEmpty()

JobQueueAggregatorMemc::doNotifyQueueNonEmpty (   $wiki,
  $type 
)
protected
See also
JobQueueAggregator::doNotifyQueueNonEmpty()

Reimplemented from JobQueueAggregator.

Definition at line 74 of file JobQueueAggregatorMemc.php.

◆ doPurge()

JobQueueAggregatorMemc::doPurge ( )
protected
See also
JobQueueAggregator::doPurge()

Reimplemented from JobQueueAggregator.

Definition at line 115 of file JobQueueAggregatorMemc.php.

References cache, and getReadyQueueCacheKey().

◆ getReadyQueueCacheKey()

JobQueueAggregatorMemc::getReadyQueueCacheKey ( )
private
Returns
string

Definition at line 122 of file JobQueueAggregatorMemc.php.

Referenced by doGetAllReadyWikiQueues(), doNotifyQueueEmpty(), and doPurge().

Member Data Documentation

◆ $cache

BagOStuff JobQueueAggregatorMemc::$cache
protected

Definition at line 31 of file JobQueueAggregatorMemc.php.

◆ $cacheTTL

JobQueueAggregatorMemc::$cacheTTL
protected

Definition at line 33 of file JobQueueAggregatorMemc.php.

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