inc/main/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 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                HandleableDataSet looks strange here
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 interface HandleableTask extends HandleableDataSet {
  26         /**
  27          * Searches a task by given instance
  28          *
  29          * @param       $taskInstanc    An instanceof a Taskable class
  30          * @return      $taskName               Name of the task as used while registration
  31          */
  32         function searchTask (Taskable $taskInstance);
  33
  34         /**
  35          * Registers a task with a task handler.
  36          *
  37          * @param       $taskName               A task name to register the task on
  38          * @param       $taskInstance   The instance we should register as a task
  39          * @return      void
  40          */
  41         function registerTask ($taskName, Visitable $taskInstance);
  42
  43         /**
  44          * Checks whether tasks are left including idle task
  45          *
  46          * @return      $tasksLeft      Whether there are tasks left to handle
  47          */
  48         function hasTasksLeft ();
  49
  50         /**
  51          * Handles all tasks by checking if they should startup or if it is their
  52          * turn to run. You should use this method in a while() loop in conjuntion
  53          * with hasTasksLeft() so you can e.g. shutdown by adding a ShutdownTask
  54          * which will attempt to remove all tasks from the task handler.
  55          *
  56          * @return      void
  57          */
  58         function handleTasks ();
  59
  60         /**
  61          * Shuts down all tasks and the task handler itself. This method should be
  62          * called from a corresponding filter class.
  63          *
  64          * @return      void
  65          */
  66         function doShutdown ();
  67 }
  68
  69 // [EOF]
  70 ?>