3 * A ??? connection helper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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.ship-simu.org
10 * @todo Find an interface for hub helper
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class BaseIpV4ConnectionHelper extends BaseConnectionHelper {
29 private $connectionPort = 0;
32 * Protected constructor
34 * @param $className Name of implementing class
37 protected function __construct ($className) {
38 // Call parent constructor
39 parent::__construct($className);
43 * Getter for port number to satify HandleableProtocol
45 * @return $connectionPort The port number
47 public final function getConnectionPort () {
48 return $this->connectionPort;
52 * Setter for port number to satify HandleableProtocol
54 * @param $connectionPort The port number
57 protected final function setConnectionPort ($connectionPort) {
58 $this->connectionPort = $connectionPort;
62 * Initializes the current connection
65 * @throws SocketOptionException If setting any socket option fails
67 protected function initConnection () {
68 // Get socket resource
69 $socketResource = $this->getSocketResource();
71 // Set the option to reuse the port
72 if (!socket_set_option($socketResource, SOL_SOCKET, SO_REUSEADDR, 1)) {
73 // Handle this socket error with a faked recipientData array
74 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
77 // @TODO Move this to the socket error handler
78 throw new SocketOptionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
82 * Set socket to non-blocking mode before trying to establish a link to
83 * it. This is now the default behaviour for all connection helpers who
84 * call initConnection(); .
86 if (!socket_set_nonblock($socketResource)) {
87 // Handle this socket error with a faked recipientData array
88 $helperInstance->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
91 throw new SocketOptionException(array($helperInstance, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
94 // Last step: mark connection as initialized
95 $this->setIsInitialized(TRUE);
99 * Attempts to connect to a peer by given IP number and port from a valid
100 * unlData array with currently configured timeout.
102 * @param $unlData Valid UNL data array
103 * @return $isConnected Whether the connection went fine
104 * @see Please see http://de.php.net/manual/en/function.socket-connect.php#84465 for original code
105 * @todo Rewrite the while() loop to a iterator to not let the software stay very long here
107 protected function connectToPeerByUnlData (array $unlData) {
108 // Only call this if the connection is initialized by initConnection()
109 assert($this->isInitialized());
111 // Is unlData complete?
112 assert(isset($unlData[UniversalNodeLocator::UNL_PART_PROTOCOL]));
113 assert(isset($unlData[UniversalNodeLocator::UNL_PART_ADDRESS]));
114 assert(isset($unlData[UniversalNodeLocator::UNL_PART_PORT]));
116 // "Cache" socket resource and timeout config
117 $socketResource = $this->getSocketResource();
118 $timeout = $this->getConfigInstance()->getConfigEntry('socket_timeout_seconds');
121 self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Trying to connect to ' . $unlData[UniversalNodeLocator::UNL_PART_ADDRESS] . ':' . $unlData[UniversalNodeLocator::UNL_PART_PORT] . ' with socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' ...');
126 // Try to connect until it is connected
127 while ($isConnected = !@socket_connect($socketResource, $unlData[UniversalNodeLocator::UNL_PART_ADDRESS], $unlData[UniversalNodeLocator::UNL_PART_PORT])) {
128 // Get last socket error
129 $socketError = socket_last_error($socketResource);
131 // Skip any errors which may happen on non-blocking connections
132 if (($socketError == SOCKET_EINPROGRESS) || ($socketError == SOCKET_EALREADY)) {
133 // Now, is that attempt within parameters?
134 if ((time() - $time) >= $timeout) {
136 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: timeout=' . $timeout .' reached, connection attempt failed.');
138 // Didn't work within timeout
139 $isConnected = FALSE;
143 // Sleep about one second
145 } elseif ($socketError != 0) {
147 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: socketError=' . $socketError . ' detected.');
149 // Stop on everything else pronto
150 $isConnected = FALSE;
156 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: socketError=' . $socketError . ',isConnected=' . intval($isConnected) . ' after while() loop.');
158 // Is the peer connected?
159 if ($isConnected === TRUE) {
160 // Connection is fully established here, so change the state.
161 PeerStateFactory::createPeerStateInstanceByName('connected', $this);
164 * There was a problem connecting to the peer (this state is a meta
165 * state until the error handler has found the real cause).
167 PeerStateFactory::createPeerStateInstanceByName('problem', $this);
175 * Marks this connection as shutted down
179 protected final function markConnectionShuttedDown () {
180 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: ' . $this->__toString() . ' has been marked as shutted down');
181 $this->shuttedDown = TRUE;
183 // And remove the (now invalid) socket
184 $this->setSocketResource(FALSE);
187 // ************************************************************************
188 // Socket error handler call-back methods
189 // ************************************************************************
192 * Handles socket error 'connection timed out', but does not clear it for
193 * later debugging purposes.
195 * @param $socketResource A valid socket resource
196 * @param $unlData A valid UNL data array
198 * @throws SocketConnectionException The connection attempts fails with a time-out
200 protected function socketErrorConnectionTimedOutHandler ($socketResource, array $unlData) {
201 // Get socket error code for verification
202 $socketError = socket_last_error($socketResource);
205 $errorMessage = socket_strerror($socketError);
207 // Shutdown this socket
208 $this->shutdownSocket($socketResource);
211 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
215 * Handles socket error 'resource temporary unavailable', but does not
216 * clear it for later debugging purposes.
218 * @param $socketResource A valid socket resource
219 * @param $unlData A valid UNL data array
221 * @throws SocketConnectionException The connection attempts fails with a time-out
223 protected function socketErrorResourceUnavailableHandler ($socketResource, array $unlData) {
224 // Get socket error code for verification
225 $socketError = socket_last_error($socketResource);
228 $errorMessage = socket_strerror($socketError);
230 // Shutdown this socket
231 $this->shutdownSocket($socketResource);
234 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
238 * Handles socket error 'connection refused', but does not clear it for
239 * later debugging purposes.
241 * @param $socketResource A valid socket resource
242 * @param $unlData A valid UNL data array
244 * @throws SocketConnectionException The connection attempts fails with a time-out
246 protected function socketErrorConnectionRefusedHandler ($socketResource, array $unlData) {
247 // Get socket error code for verification
248 $socketError = socket_last_error($socketResource);
251 $errorMessage = socket_strerror($socketError);
253 // Shutdown this socket
254 $this->shutdownSocket($socketResource);
257 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
261 * Handles socket error 'no route to host', but does not clear it for later
262 * debugging purposes.
264 * @param $socketResource A valid socket resource
265 * @param $unlData A valid UNL data array
267 * @throws SocketConnectionException The connection attempts fails with a time-out
269 protected function socketErrorNoRouteToHostHandler ($socketResource, array $unlData) {
270 // Get socket error code for verification
271 $socketError = socket_last_error($socketResource);
274 $errorMessage = socket_strerror($socketError);
276 // Shutdown this socket
277 $this->shutdownSocket($socketResource);
280 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
284 * Handles socket error 'operation already in progress' which happens in
285 * method connectToPeerByUnlData() on timed out connection
288 * @param $socketResource A valid socket resource
289 * @param $unlData A valid UNL data array
291 * @throws SocketConnectionException The connection attempts fails with a time-out
293 protected function socketErrorOperationAlreadyProgressHandler ($socketResource, array $unlData) {
294 // Get socket error code for verification
295 $socketError = socket_last_error($socketResource);
298 $errorMessage = socket_strerror($socketError);
300 // Half-shutdown this socket (see there for difference to shutdownSocket())
301 $this->halfShutdownSocket($socketResource);
304 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
308 * Handles socket error 'connection reset by peer', but does not clear it for
309 * later debugging purposes.
311 * @param $socketResource A valid socket resource
312 * @param $unlData A valid UNL data array
314 * @throws SocketConnectionException The connection attempts fails with a time-out
316 protected function socketErrorConnectionResetByPeerHandler ($socketResource, array $unlData) {
317 // Get socket error code for verification
318 $socketError = socket_last_error($socketResource);
321 $errorMessage = socket_strerror($socketError);
323 // Shutdown this socket
324 $this->shutdownSocket($socketResource);
327 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
331 * Handles socket "error" 'operation now in progress' which can be safely
332 * passed on with non-blocking connections.
334 * @param $socketResource A valid socket resource
335 * @param $unlData A valid UNL data array
338 protected function socketErrorOperationInProgressHandler ($socketResource, array $unlData) {
339 self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Operation is now in progress, this is usual for non-blocking connections and is no bug.');