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