3 * A TaskHandlerInitializer filter for hubs
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 class NodeTaskHandlerInitializerFilter extends BaseNodeFilter implements Filterable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this filter class
38 * @return $filterInstance An instance of this filter class
40 public static final function createNodeTaskHandlerInitializerFilter () {
42 $filterInstance = new NodeTaskHandlerInitializerFilter();
44 // Return the instance
45 return $filterInstance;
49 * Executes the filter with given request and response objects
51 * @param $requestInstance An instance of a class with an Requestable interface
52 * @param $responseInstance An instance of a class with an Responseable interface
54 * @throws FilterChainException If the filter chain needs to be interrupted
55 * @todo Maybe some more tasks needs to be added?
57 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
59 $nodeInstance = NodeObjectFactory::createNodeInstance();
61 // Get a new task handler instance
62 $handlerInstance = ObjectFactory::createObjectByConfiguredName('task_handler_class');
64 // Put the task handler in registry
65 Registry::getRegistry()->addInstance('task_handler', $handlerInstance);
67 // Prepare a package-tags initialization task for the listeners
68 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_tags_init_task_class');
71 $handlerInstance->registerTask('package_tags_init', $taskInstance);
73 // Generate package writer task
74 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_writer_task_class');
76 // Register it as well
77 $handlerInstance->registerTask('network_package_writer', $taskInstance);
79 // Generate package reader task
80 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_reader_task_class', array($nodeInstance->getListenerPoolInstance()));
82 // Network package reader, needs to be delayed a little
83 $handlerInstance->registerTask('network_package_reader', $taskInstance);
85 // Generate socket listener task
86 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_socket_listener_task_class');
88 // Network package reader, needs to be delayed a little
89 $handlerInstance->registerTask('socket_listener', $taskInstance);
91 // Generate package decoder task
92 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_decoder_task_class');
94 // Register it as well
95 $handlerInstance->registerTask('package_decoder', $taskInstance);
97 // Generate chunk assembler task
98 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_chunk_assembler_task_class');
100 // Register it as well
101 $handlerInstance->registerTask('chunk_assembler', $taskInstance);
103 // Generate DHT initialization task
104 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_init_task_class');
106 // Register it as well
107 $handlerInstance->registerTask('dht_init', $taskInstance);
109 // Generate DHT query task
110 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_query_task_class');
112 // Register it as well
113 $handlerInstance->registerTask('dht_query', $taskInstance);
115 // Generate DHT publication-check task
116 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_check_task_class');
118 // Register it as well
119 $handlerInstance->registerTask('dht_check_publication', $taskInstance);
121 // Generate DHT publication task
122 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_task_class');
124 // Register it as well
125 $handlerInstance->registerTask('dht_publication', $taskInstance);
127 // Prepare a self-test task for the listeners
128 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_selfconnect_task_class');
131 $handlerInstance->registerTask('self_connect', $taskInstance);
133 // Prepare a update-check task
134 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_update_check_task_class');
137 $handlerInstance->registerTask('update_check', $taskInstance);
139 // Get the list instance here
140 $listInstance = $nodeInstance->getListenerPoolInstance()->getPoolEntriesInstance();
142 // Prepare a ping task
143 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_ping_task_class', array($listInstance));
146 $handlerInstance->registerTask('ping', $taskInstance);
149 * Allow extra node-depending tasks, e.g. the bootstrapper node needs
150 * booting its DHT. DHTs are decentralized and are working on
151 * peer-to-peer basis.
153 $nodeInstance->addExtraTasks($handlerInstance);