application/hub/interfaces/distributable/class_Distributable.php

   1 <?php
   2 /**
   3  * An interface for DHTs
   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  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 interface Distributable extends FrameworkInterface {
  25         /**
  26          * Initializes the distributable hash table (DHT)
  27          *
  28          * @return      void
  29          */
  30         function initDht ();
  31
  32         /**
  33          * Bootstraps the DHT by sending out a message to all available nodes
  34          * (including itself). This step helps the node to get to know more nodes
  35          * which can be queried later for object distribution.
  36          *
  37          * @return      void
  38          */
  39         function bootstrapDht ();
  40
  41         /**
  42          * Finds a node locally by given session id
  43          *
  44          * @param       $sessionId      Session id to lookup
  45          * @return      $nodeData       Node-data array
  46          */
  47         function findNodeLocalBySessionId ($sessionId);
  48
  49         /**
  50          * Registers an other node with this node by given message data. The
  51          * following data must always be present:
  52          *
  53          * - session-id  (for finding the node's record together with below data)
  54          * - external-ip (hostname or IP number)
  55          * - listen-port (TCP/UDP listen port for inbound connections)
  56          *
  57          * @param       $messageData            An array with all minimum message data
  58          * @param       $handlerInstance        An instance of a Handleable class
  59          * @param       $forceUpdate            Optionally force update, don't register (default: register if not found)
  60          * @return      void
  61          */
  62         function registerNodeByMessageData (array $messageData, Handleable $handlerInstance, $forceUpdate = FALSE);
  63
  64         /**
  65          * Queries the local DHT data(base) for a node list with all supported
  66          * object types except the node by given session id.
  67          *
  68          * @param       $messageData            An array with message data from a node_list request
  69          * @param       $handlerInstance        An instance of a Handleable class
  70          * @param       $excludeKey                     Array key which should be excluded
  71          * @param       $andKey                         Array of $separator-separated list of elements which all must match
  72          * @param       $separator                      Sepator char (1st parameter for explode() call)
  73          * @return      $nodeList                       An array with all found nodes
  74          */
  75         function queryLocalNodeListExceptByMessageData (array $messageData, Handleable $handlerInstance, $excludeKey, $andKey, $separator);
  76
  77         /**
  78          * Inserts given node list array (from earlier database result produced by
  79          * an other node) into the DHT. This array origins from above method
  80          * queryLocalNodeListExceptByMessageData().
  81          *
  82          * @param       $nodeList       An array from an earlier database result instance
  83          * @return      void
  84          */
  85         function insertNodeList (array $nodeList);
  86 }
  87
  88 // [EOF]
  89 ?>