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