*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
// Exception constants
const EXCEPTION_TASK_IS_INVALID = 0xb00;
- /**
- * A task list instance
- */
- private $listInstance = null;
-
- /**
- * Instance for iterator
- */
- private $iteratorInstance = null;
-
- /**
- * Visitor instance for all tasks while they are active
- */
- private $visitorInstance = null;
-
/**
* Protected constructor
*
// Call parent constructor
parent::__construct(__CLASS__);
- // Init the task list
- $this->listInstance = ObjectFactory::createObjectByConfiguredName('task_list_class');
-
- // Get default instance
- $this->iteratorInstance = $this->listInstance->getIterator();
-
- // Init visitor instance for faster loop
- $this->visitorInstance = ObjectFactory::createObjectByConfiguredName('active_task_visitor_class');
+ // Set handler name
+ $this->setHandlerName('task');
}
/**
*
* @return $handlerInstance An instance of a HandleableTask class
*/
- public final static function createTaskHandler () {
+ public static final function createTaskHandler () {
// Get new instance
$handlerInstance = new TaskHandler();
// Output debug message
- $handlerInstance->debugOutput('TASK-HANDLER: Task handler initialized.');
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Initializing task handler.');
+
+ // Init the task list
+ $handlerInstance->setListInstance(ObjectFactory::createObjectByConfiguredName('task_list_class'));
+
+ // Get default instance
+ $handlerInstance->setIteratorInstance($handlerInstance->getListInstance()->getIterator());
+
+ // Init visitor instance for faster loop
+ $handlerInstance->setVisitorInstance(ObjectFactory::createObjectByConfiguredName('active_task_visitor_class'));
+
+ // Register the first (and generic) idle-loop task
+ $taskInstance = ObjectFactory::createObjectByConfiguredName('idle_task_class');
+ $handlerInstance->registerTask('idle_loop', $taskInstance);
+
+ // Output debug message
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Task handler initialized.');
// Return the prepared instance
return $handlerInstance;
*/
private function executeCurrentTask () {
// Update no task by default
- $updateTask = false;
+ $updateTask = FALSE;
// Is the current task valid?
- if (!$this->iteratorInstance->valid()) {
+ if (!$this->getListInstance()->getIterator()->valid()) {
// Not valid!
throw new InvalidTaskException($this, self::EXCEPTION_TASK_IS_INVALID);
} // END - if
// Get current task
- $currentTask = $this->iteratorInstance->current();
+ $currentTask = $this->getListInstance()->getIterator()->current();
// Is the task not yet started?
- if ($currentTask['task_started'] === false) {
+ if ($currentTask['task_started'] === FALSE) {
// Determine difference between current time and registration
$diff = ($this->getMilliTime() - $currentTask['task_registered']) * 1000;
// Should we start now?
if ($diff < $currentTask['task_startup_delay']) {
// Skip this silently
- return false;
+ return;
} // END - if
// Launch the task and mark it as updated
- $currentTask['task_started'] = true;
- $updateTask = true;
+ $currentTask['task_started'] = TRUE;
+ $updateTask = TRUE;
+
+ // Debug message
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Task ' . $currentTask['id'] . ' started with startup_delay=' . $currentTask['task_startup_delay'] . 'ms');
} // END - if
// Get time difference from interval delay
$diff = ($this->getMilliTime() - $currentTask['task_last_activity']) * 1000;
// Is the interval delay reached?
- if ($diff < $currentTask['task_interval_delay']) {
+ if ((($diff < $currentTask['task_interval_delay']) && ($currentTask['task_max_runs'] == 0)) || (($currentTask['task_total_runs'] == $currentTask['task_max_runs']) && ($currentTask['task_max_runs'] > 0))) {
// Should we update the task from startup?
- if ($updateTask === true) {
+ if ($updateTask === TRUE) {
// Update the task before leaving
$this->updateTask($currentTask);
} // END - if
// Skip this silently
- return false;
+ return;
} // END - if
// Set last activity
$currentTask['task_last_activity'] = $this->getMilliTime();
+ // Count this run
+ $currentTask['task_total_runs']++;
+
// Update the task
$this->updateTask($currentTask);
// And visit/run it
// @TODO Messurement can be added around this call
- $currentTask['task_instance']->accept($this->visitorInstance);
+ $currentTask['task_instance']->accept($this->getVisitorInstance());
}
/**
*/
private function updateTask (array $taskEntry) {
// Get the key from current iteration
- $key = $this->iteratorInstance->key();
+ $key = $this->getListInstance()->getIterator()->key();
// Get the hash from key
- $hash = $this->listInstance->getHash($key);
+ $hash = $this->getListInstance()->getHash($key);
// Update the entry
- $this->listInstance->updateCurrentEntryByHash($hash, $taskEntry);
+ $this->getListInstance()->updateCurrentEntryByHash($hash, $taskEntry);
}
+ /**
+ * Unregisters the given task
+ *
+ * @param $taskData Data of the task
+ * @return void
+ */
+ private function unregisterTask (array $taskData) {
+ // Debug output
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Removing task ' . $taskData['id'] . ' from queue - START');
+
+ // Remove the entry
+ $this->getListInstance()->removeEntry('tasks', $taskData);
+
+ // Debug output
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Removing task ' . $taskData['id'] . ' from queue - FINISHED');
+ }
+
/**
* Registers a task with a task handler.
*
$taskEntry = array(
// Identifier for the generateHash() method
'id' => $taskName,
- // Wether the task is started
- 'task_started' => false,
- // Wether the task is paused (not yet implemented)
- 'task_paused' => false,
- // Wether the task can be paused (not yet implemented)
- 'task_pauseable' => true,
+ // Whether the task is started
+ 'task_started' => FALSE,
+ // Whether the task is paused (not yet implemented)
+ 'task_paused' => FALSE,
+ // Whether the task can be paused (not yet implemented)
+ 'task_pauseable' => TRUE,
// Timestamp of registration
'task_registered' => $this->getMilliTime(),
// Last activity timestamp
'task_last_activity' => 0,
+ // Total runs of this task
+ 'task_total_runs' => 0,
// Task instance itself
'task_instance' => $taskInstance,
// Startup delay in milliseconds
'task_startup_delay' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_startup_delay'),
// Interval time (delay) in milliseconds before this task is executed again
'task_interval_delay' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_interval_delay'),
+ // How often should this task run?
+ 'task_max_runs' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_max_runs'),
);
// Add the entry
- $this->listInstance->addEntry('tasks', $taskEntry);
+ $this->getListInstance()->addEntry('tasks', $taskEntry);
// Debug message
- $this->debugOutput('TASK-HANDLER: Task ' . $taskName .
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Task registered: taskName=' . $taskName .
' (taskInstance=' . $taskInstance->__toString() . ')' .
', startupDelay=' . $taskEntry['task_startup_delay'] . 'ms' .
- ', intervalDelay=' . $taskEntry['task_interval_delay'] . 'ms registered.'
+ ', intervalDelay=' . $taskEntry['task_interval_delay'] . 'ms' .
+ ', maxRuns=' . $taskEntry['task_max_runs'] . ' ...'
);
}
/**
- * Checks wether tasks are left including idle task
+ * Checks whether tasks are left including idle task
*
- * @return $tasksLeft Wether there are tasks left to handle
+ * @return $tasksLeft Whether there are tasks left to handle
*/
public function hasTasksLeft () {
// Do we have tasks there?
- $tasksLeft = (($this->listInstance instanceof Listable) && ($this->listInstance->count() > 0));
+ $tasksLeft = (($this->getListInstance() instanceof Listable) && ($this->getListInstance()->count() > 0));
// Return result
return $tasksLeft;
*/
public function handleTasks () {
// Should we rewind?
- if (!$this->iteratorInstance->valid()) {
+ if (!$this->getListInstance()->getIterator()->valid()) {
// Rewind to the beginning for next loop
- $this->iteratorInstance->rewind();
+ $this->getListInstance()->getIterator()->rewind();
} // END - if
// Try to execute the task
$this->executeCurrentTask();
// Go to next entry
- $this->iteratorInstance->next();
+ $this->getListInstance()->getIterator()->next();
+ }
+
+ /**
+ * Shuts down all tasks and the task handler itself. This method should be
+ * called from a corresponding filter class.
+ *
+ * @return void
+ */
+ public function doShutdown () {
+ // Always rewind to the beginning for next loop
+ $this->getListInstance()->getIterator()->rewind();
+
+ // Debug message
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Shutting down all ' . $this->getListInstance()->count() . ' tasks...');
+
+ // Remember all tasks that has been shutdown for removal
+ $tasks = array();
+
+ // Instance a visitor
+ $this->setVisitorInstance(ObjectFactory::createObjectByConfiguredName('shutdown_task_visitor_class'));
+
+ // Shutdown all tasks in once go
+ while ($this->getListInstance()->getIterator()->valid()) {
+ // Get current entry
+ $currentTask = $this->getListInstance()->getIterator()->current();
+
+ // Output debug message
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Shutting down task ' . $currentTask['id'] . ' (taskInstance=' . $currentTask['task_instance']->__toString() . ') ...');
+
+ // Shutdown the task
+ $currentTask['task_instance']->accept($this->getVisitorInstance());
+
+ // Remember this task
+ array_push($tasks, $currentTask);
+
+ // Advance to next one
+ $this->getListInstance()->getIterator()->next();
+ } // END - while
+
+ // Debug message
+ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __LINE__ . ']: Shutdown of all tasks completed.');
+
+ // Remove all tasks
+ foreach ($tasks as $entry) {
+ $this->unregisterTask($entry);
+ } // END - foreach
}
}
projects / hub.git / blobdiff