Class for dealing with PoolCounters using class members. More...
Public Member Functions | |
| __construct ( $type, $key) | |
| doWork () | |
| Actually perform the work, caching it if needed. | |
| error ( $status) | |
| Do something with the error, like showing it to the user. | |
| execute ( $skipcache=false) | |
| Get the result of the work (whatever it is), or the result of the error() function. | |
| fallback () | |
| A work not so good (eg. | |
| getCachedWork () | |
| Retrieve the work from cache. | |
| logError ( $status) | |
| Log an error. | |
Protected Attributes | |
| bool | $cacheable = false |
| string | $type = 'generic' |
Detailed Description
Class for dealing with PoolCounters using class members.
Definition at line 27 of file PoolCounterWork.php.
Constructor & Destructor Documentation
◆ __construct()
| PoolCounterWork::__construct | ( | $type, | |
| $key ) |
- Parameters
-
string $type The class of actions to limit concurrency for (task type) string $key Key that identifies the queue this work is placed on
Definition at line 37 of file PoolCounterWork.php.
References $type, PoolCounter\factory(), and type.
Member Function Documentation
◆ doWork()
|
abstract |
Actually perform the work, caching it if needed.
- Returns
- mixed Work result or false
Reimplemented in PoolCounterWorkViaCallback, and PoolWorkArticleView.
Referenced by execute().
◆ error()
| PoolCounterWork::error | ( | $status | ) |
Do something with the error, like showing it to the user.
- Parameters
-
Status $status
- Returns
- bool
Reimplemented in PoolCounterWorkViaCallback, and PoolWorkArticleView.
Definition at line 72 of file PoolCounterWork.php.
◆ execute()
| PoolCounterWork::execute | ( | $skipcache = false | ) |
Get the result of the work (whatever it is), or the result of the error() function.
This returns the result of the first applicable method that returns a non-false value, where the methods are checked in the following order:
- a) doWork() : Applies if the work is exclusive or no another process is doing it, and on the condition that either this process successfully entered the pool or the pool counter is down.
- b) doCachedWork() : Applies if the work is cacheable and this blocked on another process which finished the work.
- c) fallback() : Applies for all remaining cases. If these all fall through (by returning false), then the result of error() is returned.
- Parameters
-
bool $skipcache
- Returns
- mixed
Definition at line 104 of file PoolCounterWork.php.
References $result, PoolCounter\DONE, doWork(), error, PoolCounter\ERROR, execute(), fallback(), getCachedWork(), PoolCounter\LOCK_HELD, PoolCounter\LOCKED, logError(), PoolCounter\QUEUE_FULL, and PoolCounter\TIMEOUT.
Referenced by PdfHandler\doTransform(), DjVuHandler\doTransform(), SpecialContributions\execute(), PdfHandler\getMetaArray(), File\getThumbnailSource(), and wfGenerateThumbnail().
◆ fallback()
| PoolCounterWork::fallback | ( | ) |
A work not so good (eg.
expired one) but better than an error message.
- Returns
- mixed Work result or false
Reimplemented in PoolCounterWorkViaCallback, and PoolWorkArticleView.
Definition at line 61 of file PoolCounterWork.php.
Referenced by execute().
◆ getCachedWork()
| PoolCounterWork::getCachedWork | ( | ) |
Retrieve the work from cache.
- Returns
- mixed Work result or false
Reimplemented in PoolCounterWorkViaCallback, and PoolWorkArticleView.
Definition at line 52 of file PoolCounterWork.php.
Referenced by execute().
◆ logError()
| PoolCounterWork::logError | ( | $status | ) |
Log an error.
- Parameters
-
Status $status
- Returns
- void
Definition at line 82 of file PoolCounterWork.php.
References wfDebugLog().
Referenced by execute().
Member Data Documentation
◆ $cacheable
|
protected |
Definition at line 31 of file PoolCounterWork.php.
◆ $type
|
protected |
Definition at line 29 of file PoolCounterWork.php.
Referenced by __construct(), and PoolCounterWorkViaCallback\__construct().
The documentation for this class was generated from the following file:
- includes/poolcounter/PoolCounterWork.php
