application/hub/interfaces/handler/task/class_HandleableTask.php

   1 <?php
   2 /**
   3  * A HandleableTask interface
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 interface HandleableTask extends Handleable {
  25         /**
  26          * Searches a task by given instance
  27          *
  28          * @param       $taskInstanc    An instanceof a Taskable class
  29          * @return      $taskName               Name of the task as used while registration
  30          */
  31         function searchTask (Taskable $taskInstance);
  32
  33         /**
  34          * Registers a task with a task handler.
  35          *
  36          * @param       $taskName               A task name to register the task on
  37          * @param       $taskInstance   The instance we should register as a task
  38          * @return      void
  39          */
  40         function registerTask ($taskName, Visitable $taskInstance);
  41
  42         /**
  43          * Checks whether tasks are left including idle task
  44          *
  45          * @return      $tasksLeft      Whether there are tasks left to handle
  46          */
  47         function hasTasksLeft ();
  48
  49         /**
  50          * Handles all tasks by checking if they should startup or if it is their
  51          * turn to run. You should use this method in a while() loop in conjuntion
  52          * with hasTasksLeft() so you can e.g. shutdown by adding a ShutdownTask
  53          * which will attempt to remove all tasks from the task handler.
  54          *
  55          * @return      void
  56          */
  57         function handleTasks ();
  58
  59         /**
  60          * Shuts down all tasks and the task handler itself. This method should be
  61          * called from a corresponding filter class.
  62          *
  63          * @return      void
  64          */
  65         function doShutdown ();
  66 }
  67
  68 // [EOF]
  69 ?>