application/hub/interfaces/wrapper/class_NodeInformationWrapper.php

   1 <?php
   2 /**
   3  * An interface for node-information (database) wrapper
   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 NodeInformationWrapper extends DatabaseWrapper {
  25         /**
  26          * 'Registers' a new node id along with data provided in the node instance.
  27          * This may sound confusing but avoids double code very nicely...
  28          *
  29          * @param       $nodeInstance           A node instance
  30          * @param       $requestInstance        An instance of a Requestable class
  31          * @return      void
  32          */
  33         function registerNodeId (BaseHubNode $nodeInstance, Requestable $requestInstance);
  34
  35         /**
  36          * 'Registers' a new session id along with data provided in the node instance.
  37          * This may sound confusing but avoids double code very nicely...
  38          *
  39          * @param       $nodeInstance           An instance of a BaseHubNode class
  40          * @param       $requestInstance        An instance of a Requestable class
  41          * @param       $searchInstance         An instance of a LocalSearchCriteria class
  42          * @return      void
  43          */
  44         function registerSessionId (BaseHubNode $nodeInstance, Requestable $requestInstance, LocalSearchCriteria $searchInstance);
  45
  46         /**
  47          * 'Registers' a private key  along with data provided in the node instance.
  48          * This may sound confusing but avoids double code very nicely...
  49          *
  50          * @param       $nodeInstance           An instance of a BaseHubNode class
  51          * @param       $requestInstance        An instance of a Requestable class
  52          * @param       $searchInstance         An instance of a LocalSearchCriteria class
  53          * @return      void
  54          */
  55         function registerPrivateKey (BaseHubNode $nodeInstance, Requestable $requestInstance, LocalSearchCriteria $searchInstance);
  56 }
  57
  58 // [EOF]
  59 ?>