3 * A HandleableTask interface
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 interface HandleableTask extends HandleableDataSet {
26 * Searches a task by given instance
28 * @param $taskInstanc An instanceof a Taskable class
29 * @return $taskName Name of the task as used while registration
31 function searchTask (Taskable $taskInstance);
34 * Registers a task with a task handler.
36 * @param $taskName A task name to register the task on
37 * @param $taskInstance The instance we should register as a task
40 function registerTask ($taskName, Visitable $taskInstance);
43 * Checks whether tasks are left including idle task
45 * @return $tasksLeft Whether there are tasks left to handle
47 function hasTasksLeft ();
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.
57 function handleTasks ();
60 * Shuts down all tasks and the task handler itself. This method should be
61 * called from a corresponding filter class.
65 function doShutdown ();