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

   1 <?php
   2 /**
   3  * An interface for "node-helper" classes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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
  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, AddableCriteria {
  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          * Outputs the console teaser. This should only be executed on startup or
  37          * full restarts. This method generates some space around the teaser.
  38          *
  39          * @return      void
  40          */
  41         function outputConsoleTeaser ();
  42
  43         /**
  44          * Add some node-specific filters
  45          *
  46          * @return      void
  47          */
  48         function addExtraNodeFilters ();
  49
  50         /**
  51          * Generic method to acquire a hub-id. On first run this generates a new one
  52          * based on many pseudo-random data. On any later run, unless the id
  53          * got not removed from database, it will be restored from the database.
  54          *
  55          * @param       $requestInstance        A Requestable class
  56          * @param       $responseInstance       A Responseable class
  57          * @return      void
  58          */
  59         function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance);
  60
  61         /**
  62          * Activates the hub by doing some final preparation and setting
  63          * $hubIsActive to TRUE.
  64          *
  65          * @param       $requestInstance        A Requestable class
  66          * @param       $responseInstance       A Responseable class
  67          * @return      void
  68          */
  69         function activateNode (Requestable $requestInstance, Responseable $responseInstance);
  70
  71         /**
  72          * Generates a session id which will be sent to the other hubs and peers
  73          *
  74          * @return      void
  75          */
  76         function bootstrapGenerateSessionId ();
  77
  78         /**
  79          * Generates a private key for en-/decryption
  80          *
  81          * @return      void
  82          */
  83         function bootstrapGeneratePrivateKey ();
  84
  85         /**
  86          * Initializes the listener pool (class)
  87          *
  88          * @return      void
  89          */
  90         function initializeListenerPool ();
  91
  92         /**
  93          * Announces this hub to the upper (bootstrap or list) hubs. After this is
  94          * successfully done the given task is unregistered from the handler.
  95          *
  96          * @param       $taskInstance   The task instance running this announcement
  97          * @return      void
  98          * @throws      NodeAlreadyAnnouncedException   If this hub is already announced
  99          */
 100         function announceToUpperNodes (Taskable $taskInstance);
 101
 102         /**
 103          * Does a self-connect attempt on the public IP address. This should make
 104          * it sure, we are reachable from outside world.
 105          *
 106          * @param       $taskInstance   The task instance running this announcement
 107          * @return      void
 108          */
 109         function doSelfConnection (Taskable $taskInstance);
 110
 111         /**
 112          * Determines an instance of a LocateableNode class
 113          *
 114          * @return      $unlInstance    An instance of a LocateableNode class for this node
 115          */
 116         function determineUniversalNodeLocator ();
 117
 118         /**
 119          * "Getter for an array of an instance of a LocateableNode class
 120          *
 121          * @return      $unlArray       An array of an instance of a LocateableNode class
 122          */
 123         function getUniversalNodeLocatorArray ();
 124
 125         /**
 126          * Updates/refreshes node data (e.g. state).
 127          *
 128          * @return      void
 129          */
 130         function updateNodeData ();
 131
 132         /**
 133          * Checks whether this node accepts announcements
 134          *
 135          * @return      $acceptAnnouncements    Whether this node accepts announcements
 136          */
 137         function isAcceptingAnnouncements ();
 138
 139         /**
 140          * Checks whether this node has attempted to announce itself
 141          *
 142          * @return      $hasAnnounced   Whether this node has attempted to announce itself
 143          */
 144         function ifNodeIsAnnouncing ();
 145
 146         /**
 147          * Checks whether this node has attempted to announce itself and completed it
 148          *
 149          * @return      $hasAnnouncementCompleted       Whether this node has attempted to announce itself and completed it
 150          */
 151         function ifNodeHasAnnouncementCompleted ();
 152
 153         /**
 154          * Checks wether this node is accepting node-list requests
 155          *
 156          * @return      $acceptsRequest         Wether this node accepts node-list requests
 157          */
 158         function isAcceptingNodeListRequests ();
 159
 160         /**
 161          * Handles message answer by given data array
 162          *
 163          * @param       $messageData            A valid answer message data array
 164          * @param       $packageInstance        An instance of a Receivable class
 165          * @return      void
 166          */
 167         function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance);
 168
 169         /**
 170          * "Getter" for an array of all accepted object types
 171          *
 172          * @return      $objectList             Array of all accepted object types
 173          */
 174         function getListFromAcceptedObjectTypes ();
 175
 176         /**
 177          * Adds extra tasks to the given handler for this node
 178          *
 179          * @param       $handlerInstance        An instance of a HandleableTask class
 180          * @return      void
 181          */
 182         function addExtraTasks (HandleableTask $handlerInstance);
 183 }
 184
 185 // [EOF]
 186 ?>