includes/job/jobs/NullJob.php

   1 <?php
   2 /**
   3  * Degenerate job that does nothing.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * Degenerate job that does nothing, but can optionally replace itself
  26  * in the queue and/or sleep for a brief time period. These can be used
  27  * to represent "no-op" jobs or test lock contention and performance.
  28  *
  29  * @ingroup JobQueue
  30  */
  31 class NullJob extends Job {
  32         /**
  33          * @param $title Title (can be anything)
  34          * @param array $params job parameters (lives, usleep)
  35          * @param $id Integer: job id
  36          */
  37         function __construct( $title, $params, $id = 0 ) {
  38                 parent::__construct( 'null', $title, $params, $id );
  39                 if ( !isset( $this->params['lives'] ) ) {
  40                         $this->params['lives'] = 1;
  41                 }
  42                 if ( !isset( $this->params['usleep'] ) ) {
  43                         $this->params['usleep'] = 0;
  44                 }
  45                 $this->removeDuplicates = !empty( $this->params['removeDuplicates'] );
  46         }
  47
  48         public function run() {
  49                 if ( $this->params['usleep'] > 0 ) {
  50                         usleep( $this->params['usleep'] );
  51                 }
  52                 if ( $this->params['lives'] > 1 ) {
  53                         $params = $this->params;
  54                         $params['lives']--;
  55                         $job = new self( $this->title, $params );
  56                         JobQueueGroup::singleton()->push( $job );
  57                 }
  58                 return true;
  59         }
  60 }