application/hub/interfaces/lookup/peer_states/class_LookupablePeerState.php

   1 <?php
   2 /**
   3  * An interface for peer-state lookup table wrappers
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 LookupablePeerState extends Lookupable {
  25         /**
  26          * Checks whether given 'sender' is a new peer
  27          *
  28          * @param       $packageData    Raw package data
  29          * @return      $isNewPeer              Whether 'sender' is a new peer to this node
  30          */
  31         function isSenderNewPeer (array $packageData);
  32
  33         /**
  34          * Registers a peer with given package data. We use the session id from it
  35          *
  36          * @param       $packageData            Valid raw package data
  37          * @param       $socketResource         A valid socket resource
  38          * @return<>void
  39          */
  40         function registerPeerByPackageData (array $packageData, $socketResource);
  41
  42         /**
  43          * Registers the given peer state and raw package data
  44          *
  45          * @param       $stateInstance  A PeerStateable class instance
  46          * @param       $packageData    Valid package data array
  47          * @return      void
  48          */
  49         function registerPeerState (PeerStateable $stateInstance, array $packageData);
  50
  51         /**
  52          * Purges old entries of given socket resource. We use the IP address from that resource.
  53          *
  54          * @param       $socketResource         A valid socket resource
  55          * @return      void
  56          */
  57         function purgeOldEntriesBySocketResource ($socketResource);
  58
  59         /**
  60          * Checks whether a given peer state (in helper instance) is same as stored
  61          * in database compared with the one from $helperInstance.
  62          *
  63          * @param       $helperInstance                 An instance of a ConnectionHelper class
  64          * @param       $packageData                    Valid package data array
  65          * @return      $isSamePeerState                Whether the peer's state is the same
  66          */
  67         function isSamePeerState (ConnectionHelper $helperInstance, array $packageData);
  68 }
  69
  70 // [EOF]
  71 ?>