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 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 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
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.
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.
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/>.
33 interface HandleableTask extends HandleableDataSet {
35 * Searches a task by given instance
37 * @param $taskInstanc An instanceof a Taskable class
38 * @return $taskName Name of the task as used while registration
40 function searchTask (Taskable $taskInstance);
43 * Registers a task with a task handler.
45 * @param $taskName A task name to register the task on
46 * @param $taskInstance An instance of a Taskable class
49 function registerTask (string $taskName, Taskable $taskInstance);
52 * Checks whether tasks are left including idle task
54 * @return $tasksLeft Whether there are tasks left to handle
56 function hasTasksLeft ();
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.
66 function handleTasks ();
69 * Shuts down all tasks and the task handler itself. This method should be
70 * called from a corresponding filter class.
74 function doShutdown ();