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