application/hub/interfaces/distributable/node/class_DistributableNode.php

   1 <?php
   2 /**
   3  * An interface for DHTs
   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  *
  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 DistributableNode extends Distributable {
  25         /**
  26          * Finds a node locally by given session id
  27          *
  28          * @param       $sessionId      Session id to lookup
  29          * @return      $nodeData       Node-data array
  30          */
  31         function findNodeLocalBySessionId ($sessionId);
  32
  33         /**
  34          * Registers an other node with this node by given message data. The
  35          * following data must always be present:
  36          *
  37          * - session-id  (for finding the node's record together with below data)
  38          * - external-ip (hostname or IP number)
  39          * - listen-port (TCP/UDP listen port for inbound connections)
  40          *
  41          * @param       $messageData            An array with all minimum message data
  42          * @param       $handlerInstance        An instance of a HandleableDataSet class
  43          * @param       $forceUpdate            Optionally force update, don't register (default: register if not found)
  44          * @return      void
  45          */
  46         function registerNodeByMessageData (array $messageData, HandleableDataSet $handlerInstance, $forceUpdate = FALSE);
  47
  48         /**
  49          * Queries the local DHT data(base) for a node list with all supported
  50          * object types except the node by given session id.
  51          *
  52          * @param       $messageData            An array with message data from a node_list request
  53          * @param       $handlerInstance        An instance of a HandleableDataSet class
  54          * @param       $excludeKey                     Array key which should be excluded
  55          * @param       $andKey                         Array of $separator-separated list of elements which all must match
  56          * @param       $separator                      Sepator char (1st parameter for explode() call)
  57          * @return      $nodeList                       An array with all found nodes
  58          */
  59         function queryLocalNodeListExceptByMessageData (array $messageData, HandleableDataSet $handlerInstance, $excludeKey, $andKey, $separator);
  60
  61         /**
  62          * Inserts given node list array (from earlier database result produced by
  63          * an other node) into the DHT. This array origins from above method
  64          * queryLocalNodeListExceptByMessageData().
  65          *
  66          * @param       $nodeList       An array from an earlier database result instance
  67          * @return      void
  68          */
  69         function insertNodeList (array $nodeList);
  70
  71         /**
  72          * Checks whether there are entries in "INSERT" node data stack
  73          *
  74          * @return      $isPending      Whether there are pending entries
  75          */
  76         function ifInsertNodeDataPending ();
  77
  78         /**
  79          * Checks whether there are unpublished entries
  80          *
  81          * @return      $hasUnpublished         Whether there are unpublished entries
  82          */
  83         function hasUnpublishedEntries ();
  84
  85         /**
  86          * Initializes publication of DHT entries. This does only prepare
  87          * publication. The next step is to pickup such prepared entries and publish
  88          * them by uploading to other (recently appeared) DHT members.
  89          *
  90          * @return      void
  91          */
  92         function initEntryPublication ();
  93
  94         /**
  95          * Checks whether there are entries pending publication
  96          *
  97          * @return      $isPending      Whether there are entries pending publication
  98          */
  99         function hasEntriesPendingPublication ();
 100
 101         /**
 102          * Publishes next entry found in stack. This method shall also update the
 103          * corresponding dabase entry.
 104          *
 105          * @return      void
 106          */
 107         function publishEntry ();
 108 }
 109
 110 // [EOF]
 111 ?>