application/hub/main/handler/tasks/class_TaskHandler.php

   1 <?php
   2 /**
   3  * A Task handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class TaskHandler extends BaseHandler implements Registerable, HandleableTask {
  25         /**
  26          * A task list instance
  27          */
  28         private $listInstance = null;
  29
  30         /**
  31          * Instance for iterator
  32          */
  33         private $iteratorInstance = null;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43
  44                 // Init the task list
  45                 $this->listInstance = ObjectFactory::createObjectByConfiguredName('task_list_class');
  46
  47                 // Get default instance
  48                 $this->iteratorInstance = $this->listInstance->getIterator();
  49         }
  50
  51         /**
  52          * Creates an instance of this class
  53          *
  54          * @return      $handlerInstance        An instance of a HandleableTask class
  55          */
  56         public final static function createTaskHandler () {
  57                 // Get new instance
  58                 $handlerInstance = new TaskHandler();
  59
  60                 // Output debug message
  61                 $handlerInstance->debugOutput('TASK-HANDLER: Task handler initialized.');
  62
  63                 // Return the prepared instance
  64                 return $handlerInstance;
  65         }
  66
  67         /**
  68          * Registers a task with a task handler. This method throws a
  69          * TaskAlreadyRegisteredException if the task has already been registered
  70          *
  71          * @param       $taskName               A task name to register the task on
  72          * @param       $taskInstance   The instance we should register as a task
  73          * @return      void
  74          */
  75         public function registerTask ($taskName, Visitable $taskInstance) {
  76                 // Create the entry
  77                 $taskEntry = array(
  78                         'id'                  => $taskName,
  79                         'task_registered'     => time(),
  80                         'task_last_active'    => 0,
  81                         'task_instance'       => $taskInstance,
  82                         'task_startup_delay'  => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_startup_delay'),
  83                         'task_interval_delay' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_interval_delay'),
  84                 );
  85
  86                 // Add the entry
  87                 $this->listInstance->addEntry('tasks', $taskEntry);
  88
  89                 // Debug message
  90                 $this->debugOutput('TASK-HANDLER: Task ' . $taskName .
  91                         ' (taskInstance=' . $taskInstance->__toString() . ')' .
  92                         ', startupDelay=' . $taskEntry['task_startup_delay'] . 'ms' .
  93                         ', intervalDelay=' . $taskEntry['task_interval_delay'] . 'ms registered.'
  94                 );
  95         }
  96
  97         /**
  98          * Checks wether tasks are left including idle task
  99          *
 100          * @return      $tasksLeft      Wether there are tasks left to handle
 101          */
 102         public final function hasTasksLeft () {
 103                 // Do we have tasks there?
 104                 $tasksLeft = (($this->listInstance instanceof Listable) && ($this->listInstance->count() > 0));
 105
 106                 // Return result
 107                 return $tasksLeft;
 108         }
 109
 110         /**
 111          * Handles all tasks by checking if they should startup or if it is their
 112          * turn to run. You should use this method in a while() loop in conjuntion
 113          * with hasTasksLeft() so you can e.g. shutdown by adding a ShutdownTask
 114          * which will attempt to remove all tasks from the task handler.
 115          *
 116          * @return      void
 117          */
 118         public function handleTasks () {
 119                 // Should we rewind?
 120                 if (!$this->iteratorInstance->valid()) {
 121                         // Rewind to the beginning for next loop
 122                         $this->iteratorInstance->rewind();
 123                 } // END - if
 124
 125                 // Get current entry
 126                 $taskEntry = $this->iteratorInstance->current();
 127
 128                 // Debug message
 129                 $this->debugOutput('Handling task ' . $taskEntry['id']);
 130
 131                 // Go to next entry
 132                 $this->iteratorInstance->next();
 133         }
 134 }
 135
 136 // [EOF]
 137 ?>