3 * A TaskHandlerInitializer filter for hubs
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 // Prepare a package-tags initialization task for the listeners
65 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_tags_init_task_class');
68 $handlerInstance->registerTask('package_tags_init', $taskInstance);
70 // Generate package writer task
71 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_writer_task_class');
73 // Register it as well
74 $handlerInstance->registerTask('network_package_writer', $taskInstance);
76 // Generate package reader task
77 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_reader_task_class', array($nodeInstance->getListenerPoolInstance()));
79 // Network package reader, needs to be delayed a little
80 $handlerInstance->registerTask('network_package_reader', $taskInstance);
82 // Generate socket listener task
83 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_socket_listener_task_class');
85 // Network package reader, needs to be delayed a little
86 $handlerInstance->registerTask('socket_listener', $taskInstance);
88 // Generate package decoder task
89 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_decoder_task_class');
91 // Register it as well
92 $handlerInstance->registerTask('package_decoder', $taskInstance);
94 // Generate chunk assembler task
95 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_chunk_assembler_task_class');
97 // Register it as well
98 $handlerInstance->registerTask('chunk_assembler', $taskInstance);
100 // Generate DHT initialization task
101 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_init_task_class');
103 // Register it as well
104 $handlerInstance->registerTask('dht_init', $taskInstance);
106 // Generate DHT query task
107 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_query_task_class');
109 // Register it as well
110 $handlerInstance->registerTask('dht_query', $taskInstance);
112 // Generate DHT publication-check task
113 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_check_task_class');
115 // Register it as well
116 $handlerInstance->registerTask('dht_check_publication', $taskInstance);
118 // Generate DHT publication task
119 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_task_class');
121 // Register it as well
122 $handlerInstance->registerTask('dht_publication', $taskInstance);
124 // Prepare a self-test task for the listeners
125 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_selfconnect_task_class');
128 $handlerInstance->registerTask('self_connect', $taskInstance);
130 // Prepare a update-check task
131 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_update_check_task_class');
134 $handlerInstance->registerTask('update_check', $taskInstance);
136 // Get the list instance here
137 $listInstance = $nodeInstance->getListenerPoolInstance()->getPoolEntriesInstance();
139 // Prepare a ping task
140 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_ping_task_class', array($listInstance));
143 $handlerInstance->registerTask('ping', $taskInstance);
145 // Put the task handler in registry
146 Registry::getRegistry()->addInstance('task_handler', $handlerInstance);
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);