fa7bb033df
Follows similar commits to the objectcache, rdbms, profiler, filerepo components and other areas [1]. * Remove duplicate descriptions from file blocks in favour of class doc blocks. This reduces needless duplication and was often incorrect or outdated, and helps (ironically) to make the file header more consistently visually ignorable. * Remove `ingroup` from file blocks in class files as otherwise the file is indexed twice (e.g. in Doxygen) which makes navigation more messy. * Remove `throws` tag for an undescribed MWException that isn't meant to be caught by callers. [1] https://gerrit.wikimedia.org/r/q/message:ingroup+owner:Krinkle Change-Id: I6cd0d2a4d3179668779813a97bb55142eadf8851
92 lines
2.8 KiB
PHP
92 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* Convenience class for dealing with PoolCounter using callbacks
|
|
* @since 1.22
|
|
* @newable
|
|
* @note marked as newable in 1.35 for lack of a better alternative,
|
|
* but should use a factory in the future.
|
|
*/
|
|
class PoolCounterWorkViaCallback extends PoolCounterWork {
|
|
/** @var callable */
|
|
protected $doWork;
|
|
/** @var callable|null */
|
|
protected $doCachedWork;
|
|
/** @var callable|null */
|
|
protected $fallback;
|
|
/** @var callable|null */
|
|
protected $error;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @stable to call
|
|
* @param string $type The class of actions to limit concurrency for
|
|
* @param string $key
|
|
* @param array $callbacks Map of callbacks
|
|
*/
|
|
public function __construct( $type, $key, array $callbacks ) {
|
|
parent::__construct( $type, $key );
|
|
foreach ( [ 'doWork', 'doCachedWork', 'fallback', 'error' ] as $name ) {
|
|
if ( isset( $callbacks[$name] ) ) {
|
|
if ( !is_callable( $callbacks[$name] ) ) {
|
|
throw new MWException( "Invalid callback provided for '$name' function." );
|
|
}
|
|
$this->$name = $callbacks[$name];
|
|
}
|
|
}
|
|
if ( !isset( $this->doWork ) ) {
|
|
throw new MWException( "No callback provided for 'doWork' function." );
|
|
}
|
|
$this->cacheable = isset( $this->doCachedWork );
|
|
}
|
|
|
|
public function doWork() {
|
|
return ( $this->doWork )();
|
|
}
|
|
|
|
public function getCachedWork() {
|
|
if ( $this->doCachedWork ) {
|
|
return ( $this->doCachedWork )();
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public function fallback( $fast ) {
|
|
if ( $this->fallback ) {
|
|
return ( $this->fallback )( $fast );
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public function error( $status ) {
|
|
if ( $this->error ) {
|
|
return ( $this->error )( $status );
|
|
}
|
|
return false;
|
|
}
|
|
}
|