3 * An interface for "node-helper" classes
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo We need to find a better name for this interface
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 interface NodeHelper extends Helper {
27 * Method to "bootstrap" the node. This step does also apply provided
28 * command-line arguments stored in the request instance. You should now
29 * get it from calling $this->getRequestInstance().
33 function doBootstrapping ();
36 * Initializes hub-specific queues
40 function initQueues ();
43 * Outputs the console teaser. This should only be executed on startup or
44 * full restarts. This method generates some space around the teaser.
48 function outputConsoleTeaser ();
51 * Add some node-specific filters
55 function addExtraNodeFilters ();
58 * Generic method to acquire a hub-id. On first run this generates a new one
59 * based on many pseudo-random data. On any later run, unless the id
60 * got not removed from database, it will be restored from the database.
62 * @param $requestInstance A Requestable class
63 * @param $responseInstance A Responseable class
66 function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance);
69 * Activates the hub by doing some final preparation and setting
70 * $hubIsActive to true
72 * @param $requestInstance A Requestable class
73 * @param $responseInstance A Responseable class
76 function activateNode (Requestable $requestInstance, Responseable $responseInstance);
79 * Generates a session id which will be sent to the other hubs and peers
83 function bootstrapGenerateSessionId ();
86 * Generates a private key for en-/decryption
90 function bootstrapGeneratePrivateKey ();
93 * Initializes the listener pool (class)
97 function initializeListenerPool ();
100 * Announces this hub to the upper (bootstrap or list) hubs. After this is
101 * successfully done the given task is unregistered from the handler.
103 * @param $taskInstance The task instance running this announcement
105 * @throws NodeAlreadyAnnouncedException If this hub is already announced
107 function announceToUpperNodes (Taskable $taskInstance);
110 * Does a self-connect attempt on the public IP address. This should make
111 * it sure, we are reachable from outside world.
113 * @param $taskInstance The task instance running this announcement
116 function doSelfConnection (Taskable $taskInstance);
119 * "Getter for address:port combination
121 * @param $handlerInstance An instance of a Networkable class
122 * @return $addressPort A address:port combination for this node
124 function getAddressPort (Networkable $handlerInstance);
127 * Adds hub data elements to a given dataset instance
129 * @param $criteriaInstance An instance of a storeable criteria
130 * @param $requestInstance An instance of a Requestable class
133 function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance);
136 * Updates/refreshes node data (e.g. state).
140 function updateNodeData ();
143 * Checks whether this node accepts announcements
145 * @return $acceptAnnouncements Whether this node accepts announcements
147 function isAcceptingAnnouncements ();
150 * Checks whether this node has attempted to announce itself
152 * @return $hasAnnounced Whether this node has attempted to announce itself
154 function ifNodeHasAnnounced ();
157 * Checks whether this node has attempted to announce itself and completed it
159 * @return $hasAnnouncementCompleted Whether this node has attempted to announce itself and completed it
161 function ifNodeHasAnnouncementCompleted ();
164 * Checks wether this node is accepting node-list requests
166 * @return $acceptsRequest Wether this node accepts node-list requests
168 function isAcceptingNodeListRequests ();
171 * Handles message answer by given data array
173 * @param $messageData A valid answer message data array
174 * @param $packageInstance An instance of a Receivable class
177 function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance);
180 * "Getter" for an array of all accepted object types
182 * @return $objectList Array of all accepted object types
184 function getListFromAcceptedObjectTypes ();