application/hub/classes/resolver/state/peer/class_PeerStateResolver.php

   1 <?php
   2 /**
   3  * A resolver for resolving peer states locally
   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 class PeerStateResolver extends BaseStateResolver implements StateResolver {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set prefix to 'Peer'
  35                 $this->setStatePrefix('Peer');
  36         }
  37
  38         /**
  39          * Creates an instance of a resolver class with a given state
  40          *
  41          * @return      $resolverInstance       The prepared state resolver instance
  42          */
  43         public static final function createPeerStateResolver () {
  44                 // Create the new instance
  45                 $resolverInstance = new PeerStateResolver();
  46
  47                 // Return the prepared instance
  48                 return $resolverInstance;
  49         }
  50
  51         /**
  52          * Returns an state instance for a given raw package data and socket resource
  53          *
  54          * @param       $helperInstance         An instance of a ConnectionHelper class
  55          * @param       $packageData            Raw package data
  56          * @param       $socketResource         A valid socket resource
  57          * @return      $stateInstance          An instance of the resolved state
  58          * @throws      InvalidSocketException  If socketResource, even from getSocketResource() is no valid resource
  59          * @todo        ~30% done
  60          */
  61         public static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource) {
  62                 // Get temporary resolver instance
  63                 $resolverInstance = self::createPeerStateResolver();
  64
  65                 // Init state instance
  66                 $stateInstance = NULL;
  67
  68                 // Is the socket resource valid?
  69                 if (!is_resource($socketResource)) {
  70                         // No, so get socket resource from helper
  71                         $socketResource = $helperInstance->getSocketResource();
  72
  73                         // Still no socket resource?
  74                         if (!is_resource($socketResource)) {
  75                                 // Then abort here with an exception (may happen after socket_shutdown())
  76                                 throw new InvalidSocketException(array($helperInstance, $socketResource, 'unknown', 'unknown'), BaseListener::EXCEPTION_INVALID_SOCKET);
  77                         } // END - if
  78                 } // END - if
  79
  80                 // Get error code from it
  81                 $errorCode = socket_last_error($socketResource);
  82
  83                 // Translate the error code to an own name
  84                 $errorCode = $helperInstance->translateSocketErrorCodeToName($errorCode);
  85
  86                 // Create a state instance based on $errorCode. This factory does the hard work for us
  87                 $stateInstance = PeerStateFactory::createPeerStateInstanceBySocketStatusCode($helperInstance, $packageData, $socketResource, $errorCode);
  88
  89                 // Return the prepared instance
  90                 return $stateInstance;
  91         }
  92 }
  93
  94 // [EOF]
  95 ?>