3 * A resolver for resolving peer states locally
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class PeerStateResolver extends BaseStateResolver implements StateResolver {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set prefix to 'Peer'
35 $this->setStatePrefix('Peer');
39 * Creates an instance of a resolver class with a given state
41 * @return $resolverInstance The prepared state resolver instance
43 public static final function createPeerStateResolver () {
44 // Create the new instance
45 $resolverInstance = new PeerStateResolver();
47 // Return the prepared instance
48 return $resolverInstance;
52 * Returns an state instance for a given raw package data and socket resource
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
60 public static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource) {
61 // Get temporary resolver instance
62 $resolverInstance = self::createPeerStateResolver();
64 // Init state instance
65 $stateInstance = NULL;
67 // Is the socket resource valid?
68 if (!is_resource($socketResource)) {
69 // No, so get socket resource from helper
70 $socketResource = $helperInstance->getSocketResource();
73 // Get error code from it
74 $errorCode = socket_last_error($socketResource);
76 // Translate the error code to an own name
77 $errorCode = $helperInstance->translateSocketErrorCodeToName($errorCode);
79 // Create a state instance based on $errorCode. This factory does the hard work for us
80 $stateInstance = PeerStateFactory::createPeerStateInstanceBySocketStatusCode($helperInstance, $packageData, $socketResource, $errorCode);
82 // Return the prepared instance
83 return $stateInstance;