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          * Finds a node by given session id
  34          *
  35          * @param       $sessionId      Session id to lookup
  36          * @return      $nodeData       Node data array
  37          */
  38         function findNodeBySessionId ($sessionId);
  39
  40         /**
  41          * Registers an other node with this node by given message data. The
  42          * following data must always be present:
  43          *
  44          * - session-id  (for finding the node's record together with below data)
  45          * - external-ip (hostname or IP number)
  46          * - listen-port (TCP/UDP listen port for inbound connections)
  47          *
  48          * @param       $messageData            An array with all minimum message data
  49          * @param       $handlerInstance        An instance of a Handleable class
  50          * @param       $forceUpdate            Optionally force update, don't register (default: register if not found)
  51          * @return      void
  52          */
  53         function registerNodeByMessageData (array $messageData, Handleable $handlerInstance, $forceUpdate = FALSE);
  54
  55         /**
  56          * Queries the local DHT data(base) for a node list with all supported
  57          * object types except the node by given session id.
  58          *
  59          * @param       $messageData            An array with message data from a node_list request
  60          * @param       $handlerInstance        An instance of a Handleable class
  61          * @param       $excludeKey                     Array key which should be excluded
  62          * @param       $andKey                         Array of $separator-separated list of elements which all must match
  63          * @param       $separator                      Sepator char (1st parameter for explode() call)
  64          * @return      $nodeList                       An array with all found nodes
  65          */
  66         function queryLocalNodeListExceptByMessageData (array $messageData, Handleable $handlerInstance, $excludeKey, $andKey, $separator);
  67 }
  68
  69 // [EOF]
  70 ?>