3 * A socket discovery class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 PackageSocketDiscovery extends BaseRecipientDiscovery implements DiscoverableSocket, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Create an instance of this class
38 * @return $discoveryInstance An instance of this discovery class
40 public static final function createPackageSocketDiscovery () {
41 // Get an instance of this class
42 $discoveryInstance = new PackageSocketDiscovery();
44 // Output debug message
45 self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Initialized.');
47 // Return the prepared instance
48 return $discoveryInstance;
52 * Tries to dicover the right listener instance
54 * @param $protocolInstance An instance of a HandleableProtocol class
55 * @param $packageData Raw package data
56 * @return $listenerInstance An instance of a Listenable instance or null
58 public function discoverListenerInstance (HandleableProtocol $protocolInstance, array $packageData) {
60 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolInstance=' . $protocolInstance->__toString() . ' - ENTERED!');
63 * Get the listener pool instance, we need to lookup the matching
64 * listener->poolInstance chain there.
66 $poolInstance = NodeObjectFactory::createNodeInstance()->getListenerPoolInstance();
68 // Init listener instance
69 $listenerInstance = NULL;
72 $protocolName = $protocolInstance->getProtocolName();
75 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $protocolName . ',poolEntriesInstance=' . $poolInstance->getPoolEntriesInstance()->__toString());
78 * Now we need to choose again. It is whether we are speaking with a hub
79 * or with a client. So just handle it over to all listeners in this
82 foreach ($poolInstance->getPoolEntriesInstance()->getArrayFromList($protocolName) as $listenerInstance) {
84 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $protocolName . ',listenerInstance[' . gettype($listenerInstance) . ']=' . $listenerInstance);
86 // Make sure the instance is valid
87 assert($listenerInstance instanceof Listenable);
89 // Does the listener want that package?
90 if ($listenerInstance->ifListenerAcceptsPackageData($packageData)) {
91 // This listener likes our package data, so abort here
92 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Listener is accepting package data.');
97 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Listener is NOT accepting package data.');
101 return $listenerInstance;
105 * Tries to discover the right socket for given package data and returns a
106 * matching socket resource for that protocol.
108 * @param $packageData Raw package data array
109 * @param $connectionType Type of connection, can be 'incoming' or 'outgoing', *NEVER* 'server'!
110 * @return $socketResource A valid socket resource or FALSE if an error occured
111 * @throws NoListGroupException If the procol group is not found in peer list
112 * @throws NullPointerException If listenerInstance is NULL
113 * @throws InvalidUnlException If the provided UNL cannot be validated by the protocol handler
115 public function discoverSocket (array $packageData, $connectionType) {
116 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: connectionType=' . $connectionType . ' - CALLED!');
118 // Assert on type and recipient
119 assert($connectionType != BaseConnectionHelper::CONNECTION_TYPE_SERVER);
120 assert(isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
122 // Determine protocol instance
123 $protocolInstance = $this->determineProtocolByPackageData($packageData);
126 assert($protocolInstance instanceof HandleableProtocol);
128 // Does the UNL validate?
129 if (!$protocolInstance->isValidUniversalNodeLocatorByPackageData($packageData)) {
130 // Not valid, throw exception
131 throw new InvalidUnlException(array($this, $protocolInstance, $packageData), BaseHubSystem::EXCEPTION_INVALID_UNL);
134 // Get the listener instance
135 $listenerInstance = $this->discoverListenerInstance($protocolInstance, $packageData);
137 // If there is no listener who wants to have that package, we simply drop it here
138 if (is_null($listenerInstance)) {
139 // Abort with no resource
140 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
144 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('protocolInstance=' . $protocolInstance . ',packageData=' . print_r($packageData, TRUE));
147 * Now we have the listener instance, we can determine the right
148 * resource to continue. The first step is to get the attached pool
149 * instance and pass over the whole package data to get the right
152 $socketResource = $listenerInstance->getPoolInstance()->getSocketFromPackageData($packageData, $connectionType);
155 if (is_resource($socketResource)) {
156 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',error=' . socket_strerror(socket_last_error($socketResource)) . ',packageData=' . print_r($packageData, TRUE));
158 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',packageData=' . print_r($packageData, TRUE));
161 // Is it FALSE, the recipient isn't known to us and we have no connection to it
162 if (($socketResource === FALSE) || (!is_resource($socketResource)) || (socket_last_error($socketResource) > 0)) {
163 // Try to create a new socket resource
165 // Possibly noisy debug message
166 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Trying to establish a ' . strtoupper($protocolInstance) . ' connection to ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ' ...');
168 // Get a socket resource from our factory (if succeeded)
169 $socketResource = SocketFactory::createSocketFromPackageData($packageData, $protocolInstance);
170 } catch (SocketConnectionException $e) {
171 // The connection fails of being established, so log it away
172 self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
176 // Try to resolve the socket resource
178 // Get the helper instance from registry
179 $helperInstance = Registry::getRegistry()->getInstance('connection');
181 // Possibly noisy debug message
182 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Going to resolve socket from peer state and given package data ...');
184 // Resolve the peer's state (but ignore return value)
185 PeerStateResolver::resolveStateByPackage($helperInstance, $packageData, $socketResource);
186 } catch (InvalidSocketException $e) {
187 // This cannot be fixed, so log it away
188 self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Cannot discover socket resource for recipient ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ': ' . $e->getMessage());
190 // Make any failed attempts to 'FALSE'
191 $socketResource = FALSE;
195 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: socketResource=' . $socketResource . ',packageData=' . print_r($packageData, TRUE));
196 return $socketResource;