MediaWiki  1.28.0
PoolCounter_Stub Class Reference
Inheritance diagram for PoolCounter_Stub:
Collaboration diagram for PoolCounter_Stub:

Public Member Functions

 __construct ()
 
 acquireForAnyone ()
 
 acquireForMe ()
 
 release ()
 
- Public Member Functions inherited from PoolCounter
 acquireForAnyone ()
 I want to do this task, but if anyone else does it instead, it's also fine for me. More...
 
 acquireForMe ()
 I want to do this task and I need to do it myself. More...
 
 getKey ()
 
 release ()
 I have successfully finished my task. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PoolCounter
static factory ($type, $key)
 Create a Pool counter. More...
 
- Public Attributes inherited from PoolCounter
const DONE = 3
 
const ERROR = -1
 
const LOCK_HELD = -5
 
const LOCKED = 1
 
const NOT_LOCKED = -2
 
const QUEUE_FULL = -3
 
const RELEASED = 2
 
const TIMEOUT = -4
 
- Protected Member Functions inherited from PoolCounter
 __construct ($conf, $type, $key)
 
 hashKeyIntoSlots ($type, $key, $slots)
 Given a key (any string) and the number of lots, returns a slot key (a prefix with a suffix integer from the [0..($slots-1)] range). More...
 
 onAcquire ()
 Update any lock tracking information when the lock is acquired. More...
 
 onRelease ()
 Update any lock tracking information when the lock is released. More...
 
 precheckAcquire ()
 Checks that the lock request is sane. More...
 
- Protected Attributes inherited from PoolCounter
string $key
 All workers with the same key share the lock. More...
 
int $maxqueue
 If this number of workers are already working/waiting, fail instead of wait. More...
 
int $slots = 0
 Maximum number of workers working on this task type, regardless of key. More...
 
float $timeout
 Maximum time in seconds to wait for the lock. More...
 
int $workers
 Maximum number of workers working on tasks with the same key simultaneously. More...
 

Detailed Description

Definition at line 213 of file PoolCounter.php.

Constructor & Destructor Documentation

PoolCounter_Stub::__construct ( )

Definition at line 216 of file PoolCounter.php.

Member Function Documentation

PoolCounter_Stub::acquireForAnyone ( )

Definition at line 224 of file PoolCounter.php.

References PoolCounter\LOCKED, and StatusValue\newGood().

PoolCounter_Stub::acquireForMe ( )

Definition at line 220 of file PoolCounter.php.

References PoolCounter\LOCKED, and StatusValue\newGood().

PoolCounter_Stub::release ( )

Definition at line 228 of file PoolCounter.php.

References StatusValue\newGood(), and PoolCounter\RELEASED.


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