3 * A socket discovery class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 PackageSocketDiscovery extends BaseHubDiscovery 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 $discoveryInstance->debugOutput('SOCKET-DISCOVERY: Initialized.');
47 // Return the prepared instance
48 return $discoveryInstance;
52 * Tries to dicover the right listener instance
54 * @param $protocolName Protocol name
55 * @param $packageData Raw package data
56 * @return $listenerInstance An instance of a Listenable instance or null
58 public function discoverListenerInstance ($protocolName, array $packageData) {
60 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: protocolName=' . $protocolName . ' - ENTERED!');
63 * Get the listener pool instance, we need to lookup the matching
64 * listener->poolInstance chain there.
66 $poolInstance = Registry::getRegistry()->getInstance('node')->getListenerPoolInstance();
68 // Init listener instance
69 $listenerInstance = NULL;
72 * Now we need to choose again. It is whether we are speaking with a hub
73 * or with a client. So just handle it over to all listeners in this
76 foreach ($poolInstance->getPoolEntriesInstance()->getArrayFromGroup($protocolName) as $listenerInstance) {
78 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: protocolName=' . $protocolName . ',listenerInstance=' . $listenerInstance->__toString());
80 // Does the listener want that package?
81 if ($listenerInstance->ifListenerAcceptsPackageData($packageData)) {
82 // This listener likes our package data, so abort here
83 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Listener is accepting package data.');
88 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Listener is NOT accepting package data.');
92 return $listenerInstance;
96 * Tries to discover the right socket for given package data and returns a
97 * matching socket resource for that protocol.
99 * @param $packageData Raw package data array
100 * @return $socketResource A valid socket resource or FALSE if an error occured
101 * @throws NoListGroupException If the procol group is not found in peer list
102 * @throws NullPointerException If listenerInstance is NULL
104 public function discoverSocket (array $packageData) {
105 // Determine protocol name
106 $protocolName = $this->determineProtocolByPackageData($packageData);
108 // Get the listener instance
109 $listenerInstance = $this->discoverListenerInstance($protocolName, $packageData);
111 // If there is no listener who wants to have that package, we simply drop it here
112 if (is_null($listenerInstance)) {
113 // Abort with no resource
114 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
118 * Now we have the listener instance, we can determine the right
119 * resource to continue. The first step is to get the attached pool
120 * instance and pass over the whole package data to get the right
123 $socketResource = $listenerInstance->getPoolInstance()->getSocketFromPackageData($packageData);
126 //* NOISY-DEBUG: */ $this->debugOutput('socketResource=' . $socketResource . ',packageData='.print_r($packageData,true));
128 // Is it false, the recipient isn't known to us and we have no connection to it
129 if (($socketResource === false) || (!is_resource($socketResource)) || (socket_last_error($socketResource) > 0)) {
130 // Try to create a new socket resource
132 // Possibly noisy debug message
133 /* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Trying to establish a ' . strtoupper($protocolName) . ' connection to ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ' ...');
135 // Get a socket resource from our factory (if succeeded)
136 $socketResource = SocketFactory::createSocketFromPackageData($packageData, $protocolName);
137 } catch (SocketConnectionException $e) {
138 // The connection fails of being established, so log it away
139 $this->debugOutput('SOCKET-DISCOVERY: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
143 // Try to resolve the socket resource
145 // Get the helper instance from registry
146 $helperInstance = Registry::getRegistry()->getInstance('connection');
148 // Possibly noisy debug message
149 /* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: Going to resolve socket from peer state and given package data ...');
151 // Resolve the peer's state (but ignore return value)
152 PeerStateResolver::resolveStateByPackage($helperInstance, $packageData, $socketResource);
153 } catch (InvalidSocketException $e) {
154 // This cannot be fixed, so log it away
155 $this->debugOutput('SOCKET-DISCOVERY: Cannot discover socket resource for recipient ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ': ' . $e->getMessage());
157 // Make any failed attempts to 'false'
158 $socketResource = false;
162 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-DISCOVERY: socketResource=' . $socketResource . ',packageData=' . print_r($packageData, true));
163 return $socketResource;