application/hub/interfaces/wrapper/class_NodeDhtWrapper.php

   1 <?php
   2 /**
   3  * An interface for distributed hash tables for nodes
   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 NodeDhtWrapper extends DatabaseWrapper {
  25         /**
  26          * Checks whether the local (*this*) node is registered in the DHT by
  27          * checking if the external ip/port is found.
  28          *
  29          * @return      $isRegistered   Whether *this* node is registered in the DHT
  30          */
  31         function isLocalNodeRegistered ();
  32
  33         /**
  34          * Registeres the local (*this*) node with its data in the DHT.
  35          *
  36          * @return      void
  37          */
  38         function registerLocalNode ();
  39
  40         /**
  41          * Updates local (*this*) node data in DHT, this is but not limited to the
  42          * session id, ip number (and/or hostname) and port number.
  43          *
  44          * @return      void
  45          */
  46         function updateLocalNode ();
  47
  48         /**
  49          * Finds a node by given session id
  50          *
  51          * @param       $sessionId      Session id to lookup
  52          * @return      $nodeData       Node data array
  53          */
  54         function findNodeBySessionId ($sessionId);
  55 }
  56
  57 // [EOF]
  58 ?>