MediaWiki REL1_39
|
Convenience class for dealing with PoolCounters using callbacks. More...
Public Member Functions | |
__construct ( $type, $key, array $callbacks) | |
Build a PoolCounterWork class from a type, key, and callback map. | |
doWork () | |
Actually perform the work, caching it if needed. | |
error ( $status) | |
Do something with the error, like showing it to the user. | |
fallback ( $fast) | |
A work not so good (eg. | |
getCachedWork () | |
Retrieve the work from cache. | |
Public Member Functions inherited from PoolCounterWork | |
__construct (string $type, string $key, PoolCounter $poolCounter=null) | |
execute ( $skipcache=false) | |
Get the result of the work (whatever it is), or the result of the error() function. | |
logError ( $status) | |
Log an error. | |
Protected Attributes | |
callable null | $doCachedWork |
callable | $doWork |
callable null | $error |
callable null | $fallback |
Protected Attributes inherited from PoolCounterWork | |
bool | $cacheable = false |
string | $type = 'generic' |
Additional Inherited Members | |
Protected Member Functions inherited from PoolCounterWork | |
isFastStaleEnabled () | |
Should fast stale mode be used? | |
Convenience class for dealing with PoolCounters using callbacks.
Definition at line 31 of file PoolCounterWorkViaCallback.php.
PoolCounterWorkViaCallback::__construct | ( | $type, | |
$key, | |||
array | $callbacks ) |
Build a PoolCounterWork class from a type, key, and callback map.
The callback map must at least have a callback for the 'doWork' method. Additionally, callbacks can be provided for the 'doCachedWork', 'fallback', and 'error' methods. Methods without callbacks will be no-ops that return false. If a 'doCachedWork' callback is provided, then execute() may wait for any prior process in the pool to finish and reuse its cached result.
string | $type | The class of actions to limit concurrency for |
string | $key | |
array | $callbacks | Map of callbacks |
MWException |
Definition at line 57 of file PoolCounterWorkViaCallback.php.
References PoolCounterWork\$type, and doWork().
PoolCounterWorkViaCallback::doWork | ( | ) |
Actually perform the work, caching it if needed.
Reimplemented from PoolCounterWork.
Definition at line 73 of file PoolCounterWorkViaCallback.php.
References doWork().
Referenced by __construct(), and doWork().
PoolCounterWorkViaCallback::error | ( | $status | ) |
Do something with the error, like showing it to the user.
Status | $status |
Reimplemented from PoolCounterWork.
Definition at line 91 of file PoolCounterWorkViaCallback.php.
References error().
Referenced by error().
PoolCounterWorkViaCallback::fallback | ( | $fast | ) |
A work not so good (eg.
expired one) but better than an error message.
bool | $fast | True if PoolCounter is requesting a fast stale response (pre-wait) |
Reimplemented from PoolCounterWork.
Definition at line 84 of file PoolCounterWorkViaCallback.php.
References fallback().
Referenced by fallback().
PoolCounterWorkViaCallback::getCachedWork | ( | ) |
Retrieve the work from cache.
Reimplemented from PoolCounterWork.
Definition at line 77 of file PoolCounterWorkViaCallback.php.
|
protected |
Definition at line 35 of file PoolCounterWorkViaCallback.php.
|
protected |
Definition at line 33 of file PoolCounterWorkViaCallback.php.
|
protected |
Definition at line 39 of file PoolCounterWorkViaCallback.php.
|
protected |
Definition at line 37 of file PoolCounterWorkViaCallback.php.