application/hub/main/lookup/peer/class_PeerStateLookupTable.php

   1 <?php
   2 /**
   3  * A Peer lookup table class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 class PeerStateLookupTable extends BaseLookupTable implements LookupablePeerState {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $tableInstance  An instance of a Lookupable class
  39          */
  40         public final static function createPeerStateLookupTable () {
  41                 // Get new instance
  42                 $tableInstance = new PeerStateLookupTable();
  43
  44                 // Get a database wrapper instance
  45                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('peer_state_lookup_db_wrapper_class');
  46
  47                 // Set it for later re-use
  48                 $tableInstance->setWrapperInstance($wrapperInstance);
  49
  50                 // Return the prepared instance
  51                 return $tableInstance;
  52         }
  53
  54         /**
  55          * Checks wether given 'sender' is a new peer
  56          *
  57          * @param       $packageData    Raw package data
  58          * @return      $isNewPeer              Wether 'sender' is a new peer to this node
  59          */
  60         public function isSenderNewPeer (array $packageData) {
  61                 // Get our wrapper instance and ask for it
  62                 $isNewPeer = $this->getWrapperInstance()->isSenderNewPeer($packageData);
  63
  64                 // Return it
  65                 return $isNewPeer;
  66         }
  67
  68         /**
  69          * Registers a peer with given package data. We use the session id from it
  70          *
  71          * @param       $packageData            Valid raw package data
  72          * @param       $socketResource         A valid socket resource
  73          * @return      void
  74          */
  75         public function registerPeerByPackageData (array $packageData, $socketResource) {
  76                 // Just handle it over
  77                 $this->getWrapperInstance()->registerPeerByPackageData($packageData, $socketResource);
  78         }
  79
  80         /**
  81          * Registers the given peer state and raw package data
  82          *
  83          * @param       $stateInstance  A PeerStateable class instance
  84          * @param       $packageData    Valid package data array
  85          * @return      void
  86          */
  87         public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
  88                 die(__METHOD__."\n");
  89         }
  90
  91         /**
  92          * Purges old entries of given socket resource. We use the IP address from that resource.
  93          *
  94          * @param       $socketResource         A valid socket resource
  95          * @return      void
  96          */
  97         public function purgeOldEntriesBySocketResource ($socketResource) {
  98                 // Just handle it over
  99                 $this->getWrapperInstance()->purgeOldEntriesBySocketResource($socketResource);
 100         }
 101 }
 102
 103 // [EOF]
 104 ?>