framework/main/interfaces/handler/task/class_HandleableTask.php

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