application/hub/main/discovery/socket/class_PackageSocketDiscovery.php

   1 <?php
   2 /**
   3  * A socket discovery class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core 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 PackageSocketDiscovery extends BaseHubDiscovery implements DiscoverableSocket, Registerable {
  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          * Create an instance of this class
  37          *
  38          * @return      $discoveryInstance      An instance of this discovery class
  39          */
  40         public static final function createPackageSocketDiscovery () {
  41                 // Get an instance of this class
  42                 $discoveryInstance = new PackageSocketDiscovery();
  43
  44                 // Output debug message
  45                 $discoveryInstance->debugOutput('SOCKET-DISCOVERY: Initialized.');
  46
  47                 // Return the prepared instance
  48                 return $discoveryInstance;
  49         }
  50
  51         /**
  52          * Tries to dicover the right listener instance
  53          *
  54          * @param       $protocolName           Protocol name
  55          * @param       $packageData            Raw package data
  56          * @return      $listenerInstance       An instance of a Listenable instance or null
  57          */
  58         public function discoverListenerInstance ($protocolName, array $packageData) {
  59                 /*
  60                  * Get the listener pool instance, we need to lookup the matching
  61                  * listener->poolInstance chain there.
  62                  */
  63                 $poolInstance = Registry::getRegistry()->getInstance('node')->getListenerPoolInstance();
  64
  65                 // Init listener instance
  66                 $listenerInstance = NULL;
  67
  68                 /*
  69                  * Now we need to choose again. It is whether we are speaking with a hub
  70                  * or with a client. So just handle it over to all listeners in this
  71                  * pool.
  72                  */
  73                 foreach ($poolInstance->getPoolEntriesInstance()->getArrayFromGroup($protocolName) as $listenerInstance) {
  74                         // Does the listener want that package?
  75                         if ($listenerInstance->ifListenerAcceptsPackageData($packageData)) {
  76                                 // This listener likes our package data, so abort here
  77                                 break;
  78                         } // END - if
  79                 } // END - foreach
  80
  81                 // Return it
  82                 return $listenerInstance;
  83         }
  84
  85         /**
  86          * Tries to discover the right socket for given package data and returns a
  87          * matching socket resource for that protocol.
  88          *
  89          * @param       $packageData            Raw package data array
  90          * @return      $socketResource         A valid socket resource or FALSE if an error occured
  91          * @throws      NoListGroupException    If the procol group is not found in peer list
  92          */
  93         public function discoverSocket (array $packageData) {
  94                 // Determine protocol name
  95                 $protocolName = $this->determineProtocolByPackageData($packageData);
  96
  97                 // Get the listener instance
  98                 $listenerInstance = $this->discoverListenerInstance($protocolName, $packageData);
  99
 100                 // If there is no listener who wants to have that package, we simply drop it here
 101                 if (is_null($listenerInstance)) {
 102                         // @TODO We may need some logging here
 103                         // Abort with no resource
 104                         return false;
 105                 } // END - if
 106
 107                 /*
 108                  * Now we have the listener instance, we can determine the right
 109                  * resource to continue. The first step is to get the attached pool
 110                  * instance and pass over the whole package data to get the right
 111                  * socket.
 112                  */
 113                 $socketResource = $listenerInstance->getPoolInstance()->getSocketFromPackageData($packageData);
 114
 115                 // Is it false, the recipient isn't known to us and we have no connection to it
 116                 if (($socketResource === false) || (!is_resource($socketResource)) || (socket_last_error($socketResource) > 0)) {
 117                         // Try to create a new socket resource
 118                         try {
 119                                 // Possibly noisy debug message
 120                                 /* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Trying to establish a ' . strtoupper($protocolName) . ' connection to ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ' ...');
 121
 122                                 // Get a socket resource from our factory (if succeeded)
 123                                 $socketResource = SocketFactory::createSocketFromPackageData($packageData, $protocolName);
 124                         } catch (SocketConnectionException $e) {
 125                                 // The connection fails of being established, so log it away
 126                                 $this->debugOutput('SOCKET-DISCOVERY: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
 127                         }
 128                 } // END - if
 129
 130                 // Try to resolve the socket resource
 131                 try {
 132                         // Get the helper instance from registry
 133                         $helperInstance = Registry::getRegistry()->getInstance('connection');
 134
 135                         // Possibly noisy debug message
 136                         /* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Going to resolve socket from peer state and given package data ...');
 137
 138                         // Resolve the peer's state (but ignore return value)
 139                         PeerStateResolver::resolveStateByPackage($helperInstance, $packageData, $socketResource);
 140                 } catch (InvalidSocketException $e) {
 141                         // This cannot be fixed, so log it away
 142                         $this->debugOutput('SOCKET-DISCOVERY: Cannot discover socket resource for recipient ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ': ' . $e->getMessage());
 143
 144                         // Make any failed attempts to 'false'
 145                         $socketResource = false;
 146                 }
 147
 148                 // And return it
 149                 return $socketResource;
 150         }
 151 }
 152
 153 // [EOF]
 154 ?>