MediaWiki\PoolCounter\PoolCounterClient Class Reference
Inherits MediaWiki\PoolCounter\PoolCounter.
Collaboration diagram for MediaWiki\PoolCounter\PoolCounterClient:
Public Member Functions | |
| acquireForAnyone ( $timeout=null) | |
| acquireForMe ( $timeout=null) | |
| getConn () | |
| release () | |
| sendCommand (... $args) | |
| setManager (PoolCounterConnectionManager $manager) | |
 Public Member Functions inherited from MediaWiki\PoolCounter\PoolCounter | |
| __construct (array $conf, string $type, string $key) | |
| getKey () | |
| getLogger () | |
| isFastStaleEnabled () | |
| Is fast stale mode (T250248) enabled? This may be overridden by the PoolCounterWork subclass. | |
| setLogger (LoggerInterface $logger) | |
Additional Inherited Members | |
| Public Attributes inherited from MediaWiki\PoolCounter\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 MediaWiki\PoolCounter\PoolCounter | |
| 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 sensible. | |
| Protected Attributes inherited from MediaWiki\PoolCounter\PoolCounter | |
| string | $key |
| All workers with the same key share the lock. | |
| LoggerInterface | $logger |
| 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. | |
| int | $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
- Since
- 1.16
Definition at line 28 of file PoolCounterClient.php.
Member Function Documentation
◆ acquireForAnyone()
| MediaWiki\PoolCounter\PoolCounterClient::acquireForAnyone | ( | $timeout = null | ) |
- Parameters
-
int | null $timeout
- Returns
- Status
Reimplemented from MediaWiki\PoolCounter\PoolCounter.
Definition at line 137 of file PoolCounterClient.php.
◆ acquireForMe()
| MediaWiki\PoolCounter\PoolCounterClient::acquireForMe | ( | $timeout = null | ) |
- Parameters
-
int | null $timeout
- Returns
- Status
Reimplemented from MediaWiki\PoolCounter\PoolCounter.
Definition at line 124 of file PoolCounterClient.php.
◆ getConn()
| MediaWiki\PoolCounter\PoolCounterClient::getConn | ( | ) |
- Returns
- Status
Definition at line 55 of file PoolCounterClient.php.
◆ release()
| MediaWiki\PoolCounter\PoolCounterClient::release | ( | ) |
- Returns
- Status
Reimplemented from MediaWiki\PoolCounter\PoolCounter.
Definition at line 149 of file PoolCounterClient.php.
◆ sendCommand()
| MediaWiki\PoolCounter\PoolCounterClient::sendCommand | ( | $args | ) |
- Parameters
-
string|int|float ...$args
- Returns
- Status
Definition at line 78 of file PoolCounterClient.php.
◆ setManager()
| MediaWiki\PoolCounter\PoolCounterClient::setManager | ( | PoolCounterConnectionManager | $manager | ) |
- Parameters
-
PoolCounterConnectionManager $manager
Definition at line 48 of file PoolCounterClient.php.
The documentation for this class was generated from the following file:
- includes/poolcounter/PoolCounterClient.php
