application/hub/main/pools/peer/class_DefaultPeerPool.php

   1 <?php
   2 /**
   3  * A default peer pool 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 DefaultPeerPool extends BasePool implements PoolablePeer {
  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          * @param       $listenerInstance       A Listenable instance
  39          * @return      $poolInstance           An instance a Poolable class
  40          */
  41         public final static function createDefaultPeerPool (Listenable $listenerInstance) {
  42                 // Get new instance
  43                 $poolInstance = new DefaultPeerPool();
  44
  45                 // Set the application instance
  46                 $poolInstance->setListenerInstance($listenerInstance);
  47
  48                 // Return the prepared instance
  49                 return $poolInstance;
  50         }
  51
  52         /**
  53          * Validates given socket
  54          *
  55          * @param       $socketResource         A valid socket resource
  56          * @return      void
  57          */
  58         private function validateSocket ($socketResource) {
  59                 // Is it a valid resource?
  60                 if (!is_resource($socketResource)) {
  61                         // Throw an exception
  62                         throw new InvalidSocketException(array($this, gettype($socketResource), 0, 'invalid'), BaseListener::EXCEPTION_INVALID_SOCKET);
  63                 } // END - if
  64
  65                 // Get error code
  66                 $errorCode = socket_last_error($socketResource);
  67
  68                 // Is it without any errors?
  69                 if ($errorCode > 0) {
  70                         // Get error message
  71                         $errorMessage = socket_strerror($errorCode);
  72
  73                         // Shutdown this socket
  74                         $this->getListenerInstance()->shutdownSocket($socketResource);
  75
  76                         // And throw again
  77                         throw new InvalidSocketException(array($this, gettype($socketResource), $errorCode, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
  78                 } // END - if
  79         }
  80
  81         /**
  82          * Adds a socket resource to the peer pool
  83          *
  84          * @param       $socketResource         A valid (must be!) socket resource
  85          * @return      void
  86          * @throws      InvalidSocketException  If the given resource is invalid or errorous
  87          */
  88         public function addPeer ($socketResource) {
  89                 // Validate the socket
  90                 $this->validateSocket($socketResource);
  91
  92                 // Default is this peer's IP
  93                 $peerName = '0.0.0.0';
  94
  95                 // The socket resource should not match server socket
  96                 if ($socketResource != $this->getListenerInstance()->getSocketResource()) {
  97                         // Try to determine the peer's IP number
  98                         if (!socket_getpeername($socketResource, $peerName)) {
  99                                 // Get last error
 100                                 $lastError = socket_last_error($socketResource);
 101
 102                                 // Doesn't work!
 103                                 throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 104                         } // END - if
 105                 } else {
 106                         // Server sockets won't work with socket_getpeername()
 107                         $this->debugOutput('POOL: Socket resource is server socket. This is no bug.');
 108                 }
 109
 110                 // Output error message
 111                 $this->debugOutput('POOL: Adding peer ' . $peerName);
 112
 113                 // Add it finally to the pool
 114                 $this->addPoolEntry($socketResource);
 115         }
 116
 117         /**
 118          * Getter for array of all socket resources
 119          *
 120          * @return      $sockets        An array with all sockets
 121          */
 122         public final function getAllSockets () {
 123                 // Get the list
 124                 $sockets = $this->getArrayFromList('generic');
 125
 126                 // Return it
 127                 return $sockets;
 128         }
 129
 130         /**
 131          * "Getter" for a valid socket resource from given packae data.
 132          *
 133          * @param       $packageData            Raw package data
 134          * @return      $socketResource         Socket resource
 135          */
 136         public function getSocketFromPackageData (array $packageData) {
 137                 // Default is no socket
 138                 $socketResource = false;
 139
 140                 // Get all sockets and check them, skip the server socket
 141                 foreach ($this->getAllSockets() as $socket) {
 142                         // Is this a server socket?
 143                         if ($socket === $this->getListenerInstance()->getSocketResource()) {
 144                                 // Skip this
 145                                 continue;
 146                         } // END - if
 147
 148                         // @TODO Check for IP
 149                         die(__METHOD__.':'.print_r($packageData, true));
 150                 } // END - foreach
 151
 152                 // Return the determined socket resource
 153                 return $socketResource;
 154         }
 155 }
 156
 157 // [EOF]
 158 ?>