A lot files renamed (sorry guys for the mess) and moved to sub directories

[hub.git] / application / hub / interfaces / nodes / class_NodeHelper.php

diff --git a/application/hub/interfaces/nodes/class_NodeHelper.php b/application/hub/interfaces/nodes/class_NodeHelper.php
index 75b45ee900000ee577962bfc52f46e325d807a6d..dc96ab30a5d7458c020c394e23a03565fbf298c4 100644 (file)
--- a/application/hub/interfaces/nodes/class_NodeHelper.php
+++ b/application/hub/interfaces/nodes/class_NodeHelper.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  * @todo               We need to find a better name for this interface
@@ -25,13 +25,104 @@
 interface NodeHelper extends FrameworkInterface {
        /**
         * Method to "bootstrap" the node. This step does also apply provided
-        * command-line arguments stored in the request instance
+        * command-line arguments stored in the request instance. You should now
+        * get it from calling $this->getRequestInstance().
         *
-        * @param       $requestInstance        An instance of a Requestable class
         * @return      void
         */
-       function doBootstrapping (Requestable $requestInstance);
+       function doBootstrapping ();
+
+       /**
+        * Initializes hub-specific queues
+        *
+        * @return      void
+        */
+       function initQueues ();
+
+       /**
+        * Outputs the console teaser. This should only be executed on startup or
+        * full restarts. This method generates some space around the teaser.
+        *
+        * @return      void
+        */
+       function outputConsoleTeaser ();
+
+       /**
+        * Add some node-specific filters
+        *
+        * @return      void
+        */
+       function addExtraNodeFilters ();
+
+       /**
+        * Generic method to acquire a hub-id. On first run this generates a new one
+        * based on many pseudo-random data. On any later run, unless the id
+        * got not removed from database, it will be restored from the database.
+        *
+        * @param       $requestInstance        A Requestable class
+        * @param       $responseInstance       A Responseable class
+        * @return      void
+        */
+       function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance);
+
+       /**
+        * Activates the hub by doing some final preparation and setting
+        * $hubIsActive to true
+        *
+        * @param       $requestInstance        A Requestable class
+        * @param       $responseInstance       A Responseable class
+        * @return      void
+        */
+       function activateNode (Requestable $requestInstance, Responseable $responseInstance);
+
+       /**
+        * Generates a session id which will be sent to the other hubs and peers
+        *
+        * @return      void
+        */
+       function bootstrapGenerateSessionId ();
+
+       /**
+        * Initializes the listener pool (class)
+        *
+        * @return      void
+        */
+       function initializeListenerPool ();
+
+       /**
+        * Restores a previously stored node list from database
+        *
+        * @return      void
+        */
+       function bootstrapRestoreNodeList ();
+
+       /**
+        * Announces this hub to the upper (bootstrap or list) hubs. After this is
+        * successfully done the given task is unregistered from the handler.
+        *
+        * @param       $taskInstance   The task instance running this announcement
+        * @return      void
+        * @throws      HubAlreadyAnnouncedException    If this hub is already announced
+        */
+       function announceSelfToUpperNodes (Taskable $taskInstance);
+
+       /**
+        * Does a self-connect attempt on the public IP address. This should make
+        * it sure, we are reachable from outside world.
+        *
+        * @param       $taskInstance   The task instance running this announcement
+        * @return      void
+        */
+       function doSelfConnection (Taskable $taskInstance);
+
+       /**
+        * "Getter for address:port combination
+        *
+        * @param       $handlerInstance        A valid Networkable instance
+        * @return      $addressPort            A address:port combination for this node
+        */
+       function getAddressPort (Networkable $handlerInstance);
 }
 
-//
+// [EOF]
 ?>