application/hub/interfaces/helper/nodes/class_NodeHelper.php

   1 <?php
   2 /**
   3  * An interface for "node-helper" classes
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  11  *
  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.
  16  *
  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.
  21  *
  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/>.
  24  */
  25 interface NodeHelper extends Helper {
  26         /**
  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().
  30          *
  31          * @return      void
  32          */
  33         function doBootstrapping ();
  34
  35         /**
  36          * Initializes hub-specific queues
  37          *
  38          * @return      void
  39          */
  40         function initQueues ();
  41
  42         /**
  43          * Outputs the console teaser. This should only be executed on startup or
  44          * full restarts. This method generates some space around the teaser.
  45          *
  46          * @return      void
  47          */
  48         function outputConsoleTeaser ();
  49
  50         /**
  51          * Add some node-specific filters
  52          *
  53          * @return      void
  54          */
  55         function addExtraNodeFilters ();
  56
  57         /**
  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.
  61          *
  62          * @param       $requestInstance        A Requestable class
  63          * @param       $responseInstance       A Responseable class
  64          * @return      void
  65          */
  66         function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance);
  67
  68         /**
  69          * Activates the hub by doing some final preparation and setting
  70          * $hubIsActive to true
  71          *
  72          * @param       $requestInstance        A Requestable class
  73          * @param       $responseInstance       A Responseable class
  74          * @return      void
  75          */
  76         function activateNode (Requestable $requestInstance, Responseable $responseInstance);
  77
  78         /**
  79          * Generates a session id which will be sent to the other hubs and peers
  80          *
  81          * @return      void
  82          */
  83         function bootstrapGenerateSessionId ();
  84
  85         /**
  86          * Generates a private key for en-/decryption
  87          *
  88          * @return      void
  89          */
  90         function bootstrapGeneratePrivateKey ();
  91
  92         /**
  93          * Initializes the listener pool (class)
  94          *
  95          * @return      void
  96          */
  97         function initializeListenerPool ();
  98
  99         /**
 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.
 102          *
 103          * @param       $taskInstance   The task instance running this announcement
 104          * @return      void
 105          * @throws      NodeAlreadyAnnouncedException   If this hub is already announced
 106          */
 107         function announceSelfToUpperNodes (Taskable $taskInstance);
 108
 109         /**
 110          * Does a self-connect attempt on the public IP address. This should make
 111          * it sure, we are reachable from outside world.
 112          *
 113          * @param       $taskInstance   The task instance running this announcement
 114          * @return      void
 115          */
 116         function doSelfConnection (Taskable $taskInstance);
 117
 118         /**
 119          * "Getter for address:port combination
 120          *
 121          * @param       $handlerInstance        An instance of a Networkable class
 122          * @return      $addressPort            A address:port combination for this node
 123          */
 124         function getAddressPort (Networkable $handlerInstance);
 125
 126         /**
 127          * Adds hub data elements to a given dataset instance
 128          *
 129          * @param       $criteriaInstance       An instance of a storeable criteria
 130          * @param       $requestInstance        An instance of a Requestable class
 131          * @return      void
 132          */
 133         function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance);
 134
 135         /**
 136          * Updates/refreshes node data (e.g. state).
 137          *
 138          * @return      void
 139          */
 140         function updateNodeData ();
 141
 142         /**
 143          * Checks whether this node accepts announcements
 144          *
 145          * @return      $acceptAnnouncements    Whether this node accepts announcements
 146          */
 147         function isAcceptingAnnouncements ();
 148
 149         /**
 150          * Checks whether this node has attempted to announce itself
 151          *
 152          * @return      $hasAnnounced   Whether this node has attempted to announce itself
 153          */
 154         function ifNodeHasAnnounced ();
 155
 156         /**
 157          * Checks whether this node has attempted to announce itself and completed it
 158          *
 159          * @return      $hasAnnouncementCompleted       Whether this node has attempted to announce itself and completed it
 160          */
 161         function ifNodeHasAnnouncementCompleted ();
 162
 163         /**
 164          * Checks wether this node is accepting node-list requests
 165          *
 166          * @return      $acceptsRequest         Wether this node accepts node-list requests
 167          */
 168         function isAcceptingNodeListRequests ();
 169
 170         /**
 171          * Handles message answer by given data array
 172          *
 173          * @param       $messageData            A valid answer message data array
 174          * @param       $packageInstance        An instance of a Receivable class
 175          * @return      void
 176          */
 177         function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance);
 178
 179         /**
 180          * "Getter" for an array of all accepted object types
 181          *
 182          * @return      $objectList             Array of all accepted object types
 183          */
 184         function getListFromAcceptedObjectTypes ();
 185 }
 186
 187 // [EOF]
 188 ?>