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