application/hub/main/helper/connection/class_BaseConnectionHelper.php

   1 <?php
   2 /**
   3  * A general ConnectionHelper class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 BaseConnectionHelper extends BaseHubSystemHelper implements Registerable, ProtocolHandler {
  25         // Exception codes
  26         const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x9100;
  27
  28         /**
  29          * Connection type 'incoming'
  30          */
  31         const CONNECTION_TYPE_INCOMING = 'incoming';
  32
  33         /**
  34          * Connection type 'outgoing'
  35          */
  36         const CONNECTION_TYPE_OUTGOING = 'outgoing';
  37
  38         /**
  39          * Connection type 'server'
  40          */
  41         const CONNECTION_TYPE_SERVER   = 'server';
  42
  43         /**
  44          * Protocol used
  45          */
  46         private $protocol = 'invalid';
  47
  48         /**
  49          * Port number used
  50          */
  51         private $port = 0;
  52
  53         /**
  54          * (IP) Adress used
  55          */
  56         private $address = 0;
  57
  58         /**
  59          * Sent data in bytes
  60          */
  61         private $sentData = 0;
  62
  63         /**
  64          * Difference
  65          */
  66         private $diff = 0;
  67
  68         /**
  69          * Whether this connection is initialized
  70          */
  71         private $isInitialized = FALSE;
  72
  73         /**
  74          * Whether this connection is shutted down
  75          */
  76         private $shuttedDown = FALSE;
  77
  78         /**
  79          * Currently queued chunks
  80          */
  81         private $queuedChunks = array();
  82
  83         /**
  84          * Current final hash
  85          */
  86         private $currentFinalHash = '';
  87
  88         /**
  89          * Protected constructor
  90          *
  91          * @param       $className      Name of the class
  92          * @return      void
  93          */
  94         protected function __construct ($className) {
  95                 // Call parent constructor
  96                 parent::__construct($className);
  97
  98                 // Initialize output stream
  99                 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_output_stream_class');
 100
 101                 // And add it to this connection helper
 102                 $this->setOutputStreamInstance($streamInstance);
 103
 104                 // Init state which sets the state to 'init'
 105                 $this->initState();
 106
 107                 // Register this connection helper
 108                 Registry::getRegistry()->addInstance('connection', $this);
 109
 110                 // Get the fragmenter instance
 111                 $fragmenterInstance = FragmenterFactory::createFragmenterInstance('package');
 112
 113                 // Set it here
 114                 $this->setFragmenterInstance($fragmenterInstance);
 115         }
 116
 117         /**
 118          * Getter for real class name, overwrites generic method and is final
 119          *
 120          * @return      $class  Name of this class
 121          */
 122         public final function __toString () {
 123                 // Class name representation
 124                 $class = self::getConnectionClassName($this->getAddress(), $this->getPort(), parent::__toString());
 125
 126                 // Return it
 127                 return $class;
 128         }
 129
 130         /**
 131          * Getter for port number to satify ProtocolHandler
 132          *
 133          * @return      $port   The port number
 134          */
 135         public final function getPort () {
 136                 return $this->port;
 137         }
 138
 139         /**
 140          * Setter for port number to satify ProtocolHandler
 141          *
 142          * @param       $port   The port number
 143          * @return      void
 144          */
 145         protected final function setPort ($port) {
 146                 $this->port = $port;
 147         }
 148
 149         /**
 150          * Getter for protocol
 151          *
 152          * @return      $protocol       Used protocol
 153          */
 154         public final function getProtocol () {
 155                 return $this->protocol;
 156         }
 157
 158         /**
 159          * Setter for protocol
 160          *
 161          * @param       $protocol       Used protocol
 162          * @return      void
 163          */
 164         protected final function setProtocol ($protocol) {
 165                 $this->protocol = $protocol;
 166         }
 167
 168         /**
 169          * Getter for IP address
 170          *
 171          * @return      $address        The IP address
 172          */
 173         public final function getAddress () {
 174                 return $this->address;
 175         }
 176
 177         /**
 178          * Setter for IP address
 179          *
 180          * @param       $address        The IP address
 181          * @return      void
 182          */
 183         protected final function setAddress ($address) {
 184                 $this->address = $address;
 185         }
 186
 187         /**
 188          * Initializes the current connection
 189          *
 190          * @return      void
 191          * @throws      SocketOptionException   If setting any socket option fails
 192          */
 193         protected function initConnection () {
 194                 // Get socket resource
 195                 $socketResource = $this->getSocketResource();
 196
 197                 // Set the option to reuse the port
 198                 if (!socket_set_option($socketResource, SOL_SOCKET, SO_REUSEADDR, 1)) {
 199                         // Handle this socket error with a faked recipientData array
 200                         $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
 201
 202                         // And throw again
 203                         // @TODO Move this to the socket error handler
 204                         throw new SocketOptionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 205                 } // END - if
 206
 207                 /*
 208                  * Set socket to non-blocking mode before trying to establish a link to
 209                  * it. This is now the default behaviour for all connection helpers who
 210                  * call initConnection(); .
 211                  */
 212                 if (!socket_set_nonblock($socketResource)) {
 213                         // Handle this socket error with a faked recipientData array
 214                         $helperInstance->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
 215
 216                         // And throw again
 217                         throw new SocketOptionException(array($helperInstance, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 218                 } // END - if
 219
 220                 // Last step: mark connection as initialized
 221                 $this->isInitialized = TRUE;
 222         }
 223
 224         /**
 225          * Attempts to connect to a peer by given IP number and port from a valid
 226          * recipientData array with currently configured timeout.
 227          *
 228          * @param       $recipientData  A valid recipient data array, 0=IP; 1=PORT
 229          * @return      $isConnected    Whether the connection went fine
 230          * @see         Please see http://de.php.net/manual/en/function.socket-connect.php#84465 for original code
 231          * @todo        Rewrite the while() loop to a iterator to not let the software stay very long here
 232          */
 233         protected function connectToPeerByRecipientData (array $recipientData) {
 234                 // Only call this if the connection is initialized by initConnection()
 235                 assert($this->isInitialized === TRUE);
 236
 237                 // Get current time
 238                 $time = time();
 239
 240                 // "Cache" socket resource and timeout config
 241                 $socketResource = $this->getSocketResource();
 242                 $timeout = $this->getConfigInstance()->getConfigEntry('socket_timeout_seconds');
 243
 244                 // Debug output
 245                 self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Trying to connect to ' . $recipientData[0] . ':' . $recipientData[1] . ' with socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' ...');
 246
 247                 // Try to connect until it is connected
 248                 while ($isConnected = !@socket_connect($socketResource, $recipientData[0], $recipientData[1])) {
 249                         // Get last socket error
 250                         $socketError = socket_last_error($socketResource);
 251
 252                         // Skip any errors which may happen on non-blocking connections
 253                         if (($socketError == SOCKET_EINPROGRESS) || ($socketError == SOCKET_EALREADY)) {
 254                                 // Now, is that attempt within parameters?
 255                                 if ((time() - $time) >= $timeout) {
 256                                         // Didn't work within timeout
 257                                         $isConnected = FALSE;
 258                                         break;
 259                                 } // END - if
 260
 261                                 // Sleep about one second
 262                                 $this->idle(1000);
 263                         } elseif ($socketError != 0) {
 264                                 // Stop on everything else pronto
 265                                 $isConnected = FALSE;
 266                                 break;
 267                         }
 268                 } // END - while
 269
 270                 // Is the peer connected?
 271                 if ($isConnected === TRUE) {
 272                         // Connection is fully established here, so change the state.
 273                         PeerStateFactory::createPeerStateInstanceByName('connected', $this);
 274                 } else {
 275                         /*
 276                          * There was a problem connecting to the peer (this state is a meta
 277                          * state until the error handler has found the real cause).
 278                          */
 279                         PeerStateFactory::createPeerStateInstanceByName('problem', $this);
 280                 }
 281
 282                 // Return status
 283                 return $isConnected;
 284         }
 285
 286         /**
 287          * Static "getter" for this connection class' name
 288          *
 289          * @param       $address        IP address
 290          * @param       $port           Port number
 291          * @param       $className      Original class name
 292          * @return      $class          Expanded class name
 293          */
 294         public static function getConnectionClassName ($address, $port, $className) {
 295                 // Construct it
 296                 $class = $address . ':' . $port . ':' . $className;
 297
 298                 // ... and return it
 299                 return $class;
 300         }
 301
 302         /**
 303          * Initializes the peer's state which sets it to 'init'
 304          *
 305          * @return      void
 306          */
 307         private function initState() {
 308                 /*
 309                  * Get the state factory and create the initial state, we don't need
 310                  * the state instance here
 311                  */
 312                 PeerStateFactory::createPeerStateInstanceByName('init', $this);
 313         }
 314
 315         /**
 316          * "Getter" for raw data from a package array. A fragmenter is used which
 317          * will returns us only so many raw data which fits into the back buffer.
 318          * The rest is being held in a back-buffer and waits there for the next
 319          * cycle and while be then sent.
 320          *
 321          * This method does 4 simple steps:
 322          * 1) Aquire fragmenter object instance from the factory
 323          * 2) Handle over the package data array to the fragmenter
 324          * 3) Request a chunk
 325          * 4) Finally return the chunk (array) to the caller
 326          *
 327          * @param       $packageData    Raw package data array
 328          * @return      $chunkData              Raw data chunk
 329          */
 330         private function getRawDataFromPackageArray (array $packageData) {
 331                 // Implode the package data array and fragement the resulting string, returns the final hash
 332                 $finalHash = $this->getFragmenterInstance()->fragmentPackageArray($packageData, $this);
 333                 if ($finalHash !== TRUE) {
 334                         // Debug message
 335                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Setting finalHash=' . $finalHash);
 336
 337                         // Set final hash
 338                         $this->currentFinalHash = $finalHash;
 339                 } // END - if
 340
 341                 // Debug message
 342                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: currentFinalHash=' . $this->currentFinalHash);
 343
 344                 // Get the next raw data chunk from the fragmenter
 345                 $rawDataChunk = $this->getFragmenterInstance()->getNextRawDataChunk($this->currentFinalHash);
 346
 347                 // Get chunk hashes and chunk data
 348                 $chunkHashes = array_keys($rawDataChunk);
 349                 $chunkData   = array_values($rawDataChunk);
 350
 351                 // Is the required data there?
 352                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: chunkHashes[]=' . count($chunkHashes) . ',chunkData[]=' . count($chunkData));
 353                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('chunkData='.print_r($chunkData, TRUE));
 354                 if ((isset($chunkHashes[0])) && (isset($chunkData[0]))) {
 355                         // Remember this chunk as queued
 356                         $this->queuedChunks[$chunkHashes[0]] = $chunkData[0];
 357
 358                         // Return the raw data
 359                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Returning ' . strlen($chunkData[0]) . ' bytes from ' . __METHOD__ . ' ...');
 360                         return $chunkData[0];
 361                 } else {
 362                         // Return zero string
 363                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Returning zero bytes from ' . __METHOD__ . '!');
 364                         return '';
 365                 }
 366         }
 367
 368         /**
 369          * "Accept" a visitor by simply calling it back
 370          *
 371          * @param       $visitorInstance        A Visitor instance
 372          * @return      void
 373          */
 374         protected final function accept (Visitor $visitorInstance) {
 375                 // Just call the visitor
 376                 $visitorInstance->visitConnectionHelper($this);
 377         }
 378
 379         /**
 380          * Sends raw package data to the recipient
 381          *
 382          * @param       $packageData            Raw package data
 383          * @return      $totalSentBytes         Total sent bytes to the peer
 384          * @throws      InvalidSocketException  If we got a problem with this socket
 385          */
 386         public function sendRawPackageData (array $packageData) {
 387                 // The helper's state must be 'connected'
 388                 $this->getStateInstance()->validatePeerStateConnected();
 389
 390                 // Reset serial number
 391                 $this->getFragmenterInstance()->resetSerialNumber();
 392
 393                 // Cache buffer length
 394                 $bufferSize = $this->getConfigInstance()->getConfigEntry($this->getProtocol() . '_buffer_length');
 395
 396                 // Init variables
 397                 $rawData        = '';
 398                 $dataStream     = ' ';
 399                 $totalSentBytes = 0;
 400
 401                 // Fill sending buffer with data
 402                 while (strlen($dataStream) > 0) {
 403                         // Debug message
 404                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: packageData=' . print_r($packageData, TRUE));
 405
 406                         // Convert the package data array to a raw data stream
 407                         $dataStream = $this->getRawDataFromPackageArray($packageData);
 408                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . strlen($dataStream) . ' bytes to the sending buffer ...');
 409                         $rawData .= $dataStream;
 410                 } // END - while
 411
 412                 // Nothing to sent is bad news, so assert on it
 413                 assert(strlen($rawData) > 0);
 414
 415                 // Encode the raw data with our output-stream
 416                 $encodedData = $this->getOutputStreamInstance()->streamData($rawData);
 417
 418                 // Debug message
 419                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: rawData()=' . strlen($rawData) . ',encodedData()=' . strlen($encodedData));
 420
 421                 // Calculate difference
 422                 $this->diff = $bufferSize - strlen($encodedData);
 423
 424                 // Get socket resource
 425                 $socketResource = $this->getSocketResource();
 426
 427                 // Init sent bytes
 428                 $sentBytes = 0;
 429
 430                 // Deliver all data
 431                 while ($sentBytes !== FALSE) {
 432                         // And deliver it
 433                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sending out ' . strlen($encodedData) . ' bytes,bufferSize=' . $bufferSize . ',diff=' . $this->diff);
 434
 435                         if ($this->diff >= 0) {
 436                                 // Send all out (encodedData is smaller than or equal buffer size)
 437                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: MD5=' . md5(substr($encodedData, 0, ($bufferSize - $this->diff))));
 438                                 $sentBytes = socket_write($socketResource, $encodedData, ($bufferSize - $this->diff));
 439                         } else {
 440                                 // Send buffer size out
 441                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: MD5=' . md5(substr($encodedData, 0, $bufferSize)));
 442                                 $sentBytes = socket_write($socketResource, $encodedData, $bufferSize);
 443                         }
 444
 445                         // If there was an error, we don't continue here
 446                         if ($sentBytes === FALSE) {
 447                                 // Handle the error with a faked recipientData array
 448                                 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
 449
 450                                 // And throw it
 451                                 throw new InvalidSocketException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 452                         } elseif (($sentBytes == 0) && (strlen($encodedData) > 0)) {
 453                                 // Nothing sent means we are done
 454                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
 455                                 break;
 456                         }
 457
 458                         // The difference between sent bytes and length of raw data should not go below zero
 459                         assert((strlen($encodedData) - $sentBytes) >= 0);
 460
 461                         // Add total sent bytes
 462                         $totalSentBytes += $sentBytes;
 463
 464                         // Cut out the last unsent bytes
 465                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedData) . ' bytes ...');
 466                         $encodedData = substr($encodedData, $sentBytes);
 467
 468                         // Calculate difference again
 469                         $this->diff = $bufferSize - strlen($encodedData);
 470
 471                         // Can we abort?
 472                         if (strlen($encodedData) <= 0) {
 473                                 // Abort here, all sent!
 474                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
 475                                 break;
 476                         } // END - if
 477                 } // END - while
 478
 479                 // Return sent bytes
 480                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: totalSentBytes=' . $totalSentBytes . ',diff=' . $this->diff);
 481                 return $totalSentBytes;
 482         }
 483
 484         /**
 485          * Marks this connection as shutted down
 486          *
 487          * @return      void
 488          */
 489         protected final function markConnectionShuttedDown () {
 490                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: ' . $this->__toString() . ' has been marked as shutted down');
 491                 $this->shuttedDown = TRUE;
 492
 493                 // And remove the (now invalid) socket
 494                 $this->setSocketResource(FALSE);
 495         }
 496
 497         /**
 498          * Getter for shuttedDown
 499          *
 500          * @return      $shuttedDown    Whether this connection is shutted down
 501          */
 502         public final function isShuttedDown () {
 503                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: ' . $this->__toString() . ',shuttedDown=' . intval($this->shuttedDown));
 504                 return $this->shuttedDown;
 505         }
 506
 507         // ************************************************************************
 508         //                 Socket error handler call-back methods
 509         // ************************************************************************
 510
 511         /**
 512          * Handles socket error 'connection timed out', but does not clear it for
 513          * later debugging purposes.
 514          *
 515          * @param       $socketResource         A valid socket resource
 516          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 517          * @return      void
 518          * @throws      SocketConnectionException       The connection attempts fails with a time-out
 519          */
 520         protected function socketErrorConnectionTimedOutHandler ($socketResource, array $recipientData) {
 521                 // Get socket error code for verification
 522                 $socketError = socket_last_error($socketResource);
 523
 524                 // Get error message
 525                 $errorMessage = socket_strerror($socketError);
 526
 527                 // Shutdown this socket
 528                 $this->shutdownSocket($socketResource);
 529
 530                 // Throw it again
 531                 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 532         }
 533
 534         /**
 535          * Handles socket error 'resource temporary unavailable', but does not
 536          * clear it for later debugging purposes.
 537          *
 538          * @param       $socketResource         A valid socket resource
 539          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 540          * @return      void
 541          * @throws      SocketConnectionException       The connection attempts fails with a time-out
 542          */
 543         protected function socketErrorResourceUnavailableHandler ($socketResource, array $recipientData) {
 544                 // Get socket error code for verification
 545                 $socketError = socket_last_error($socketResource);
 546
 547                 // Get error message
 548                 $errorMessage = socket_strerror($socketError);
 549
 550                 // Shutdown this socket
 551                 $this->shutdownSocket($socketResource);
 552
 553                 // Throw it again
 554                 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 555         }
 556
 557         /**
 558          * Handles socket error 'connection refused', but does not clear it for
 559          * later debugging purposes.
 560          *
 561          * @param       $socketResource         A valid socket resource
 562          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 563          * @return      void
 564          * @throws      SocketConnectionException       The connection attempts fails with a time-out
 565          */
 566         protected function socketErrorConnectionRefusedHandler ($socketResource, array $recipientData) {
 567                 // Get socket error code for verification
 568                 $socketError = socket_last_error($socketResource);
 569
 570                 // Get error message
 571                 $errorMessage = socket_strerror($socketError);
 572
 573                 // Shutdown this socket
 574                 $this->shutdownSocket($socketResource);
 575
 576                 // Throw it again
 577                 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 578         }
 579
 580         /**
 581          * Handles socket error 'no route to host', but does not clear it for later
 582          * debugging purposes.
 583          *
 584          * @param       $socketResource         A valid socket resource
 585          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 586          * @return      void
 587          * @throws      SocketConnectionException       The connection attempts fails with a time-out
 588          */
 589         protected function socketErrorNoRouteToHostHandler ($socketResource, array $recipientData) {
 590                 // Get socket error code for verification
 591                 $socketError = socket_last_error($socketResource);
 592
 593                 // Get error message
 594                 $errorMessage = socket_strerror($socketError);
 595
 596                 // Shutdown this socket
 597                 $this->shutdownSocket($socketResource);
 598
 599                 // Throw it again
 600                 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 601         }
 602
 603         /**
 604          * Handles socket error 'operation already in progress' which happens in
 605          * method connectToPeerByRecipientData() on timed out connection
 606          * attempts.
 607          *
 608          * @param       $socketResource         A valid socket resource
 609          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 610          * @return      void
 611          * @throws      SocketConnectionException       The connection attempts fails with a time-out
 612          */
 613         protected function socketErrorOperationAlreadyProgressHandler ($socketResource, array $recipientData) {
 614                 // Get socket error code for verification
 615                 $socketError = socket_last_error($socketResource);
 616
 617                 // Get error message
 618                 $errorMessage = socket_strerror($socketError);
 619
 620                 // Half-shutdown this socket (see there for difference to shutdownSocket())
 621                 $this->halfShutdownSocket($socketResource);
 622
 623                 // Throw it again
 624                 throw new SocketConnectionException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 625         }
 626
 627         /**
 628          * Handles socket "error" 'operation now in progress' which can be safely
 629          * passed on with non-blocking connections.
 630          *
 631          * @param       $socketResource         A valid socket resource
 632          * @param       $recipientData          An array with two elements: 0=IP number, 1=port number
 633          * @return      void
 634          */
 635         protected function socketErrorOperationInProgressHandler ($socketResource, array $recipientData) {
 636                 self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Operation is now in progress, this is usual for non-blocking connections and is no bug.');
 637         }
 638 }
 639
 640 // [EOF]
 641 ?>