PoolCounter_Stub Class Reference
Inheritance diagram for PoolCounter_Stub:
Collaboration diagram for PoolCounter_Stub:
Public Member Functions | |
| __construct () | |
| acquireForAnyone () | |
| I want to do this task, but if anyone else does it instead, it's also fine for me. | |
| acquireForMe () | |
| I want to do this task and I need to do it myself. | |
| release () | |
| I have successfully finished my task. | |
 Public Member Functions inherited from PoolCounter | |
| getKey () | |
Additional Inherited Members | |
| Static Public Member Functions inherited from PoolCounter | |
| static | factory ( $type, $key) |
| Create a Pool counter. | |
| 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). | |
| onAcquire () | |
| Update any lock tracking information when the lock is acquired. | |
| onRelease () | |
| Update any lock tracking information when the lock is released. | |
| precheckAcquire () | |
| Checks that the lock request is sane. | |
| Protected Attributes inherited from PoolCounter | |
| string | $key |
| All workers with the same key share the lock. | |
| int | $maxqueue |
| If this number of workers are already working/waiting, fail instead of wait. | |
| int | $slots = 0 |
| Maximum number of workers working on this task type, regardless of key. | |
| float | $timeout |
| Maximum time in seconds to wait for the lock. | |
| int | $workers |
| Maximum number of workers working on tasks with the same key simultaneously. | |
Detailed Description
Definition at line 213 of file PoolCounter.php.
Constructor & Destructor Documentation
◆ __construct()
| PoolCounter_Stub::__construct | ( | ) |
Definition at line 215 of file PoolCounter.php.
Member Function Documentation
◆ acquireForAnyone()
| PoolCounter_Stub::acquireForAnyone | ( | ) |
I want to do this task, but if anyone else does it instead, it's also fine for me.
I will read its cached data.
- Returns
- Status Value is one of Locked/Done/Error
Reimplemented from PoolCounter.
Definition at line 223 of file PoolCounter.php.
References PoolCounter\LOCKED.
◆ acquireForMe()
| PoolCounter_Stub::acquireForMe | ( | ) |
I want to do this task and I need to do it myself.
- Returns
- Status Value is one of Locked/Error
Reimplemented from PoolCounter.
Definition at line 219 of file PoolCounter.php.
References PoolCounter\LOCKED.
◆ release()
| PoolCounter_Stub::release | ( | ) |
I have successfully finished my task.
Lets another one grab the lock, and returns the workers waiting on acquireForAnyone()
- Returns
- Status Value is one of Released/NotLocked/Error
Reimplemented from PoolCounter.
Definition at line 227 of file PoolCounter.php.
References PoolCounter\RELEASED.
The documentation for this class was generated from the following file:
- includes/poolcounter/PoolCounter.php
