X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fhelper%2Fconnection%2Fclass_BaseConnectionHelper.php;h=bf0897653c363cdc58729873b21f86e92d36638b;hb=7756c313e101f012af9c3ccfc378308f4f03f603;hp=c6f5ceef4003aadb63c410b27d76fcdcaacd39b5;hpb=89f7a4909d3103489f1f04f9550eff3b4ffd3b06;p=hub.git diff --git a/application/hub/main/helper/connection/class_BaseConnectionHelper.php b/application/hub/main/helper/connection/class_BaseConnectionHelper.php index c6f5ceef4..bf0897653 100644 --- a/application/hub/main/helper/connection/class_BaseConnectionHelper.php +++ b/application/hub/main/helper/connection/class_BaseConnectionHelper.php @@ -21,9 +21,24 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class BaseConnectionHelper extends BaseHubHelper implements Registerable, ProtocolHandler { +class BaseConnectionHelper extends BaseHubSystemHelper implements Registerable, ProtocolHandler { // Exception codes - const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x900; + const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x9100; + + /** + * Connection type 'incoming' + */ + const CONNECTION_TYPE_INCOMING = 'incoming'; + + /** + * Connection type 'outgoing' + */ + const CONNECTION_TYPE_OUTGOING = 'outgoing'; + + /** + * Connection type 'server' + */ + const CONNECTION_TYPE_SERVER = 'server'; /** * Protocol used @@ -53,12 +68,12 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc /** * Whether this connection is initialized */ - private $isInitialized = false; + private $isInitialized = FALSE; /** * Whether this connection is shutted down */ - private $shuttedDown = false; + private $shuttedDown = FALSE; /** * Currently queued chunks @@ -203,7 +218,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc } // END - if // Last step: mark connection as initialized - $this->isInitialized = true; + $this->isInitialized = TRUE; } /** @@ -215,9 +230,9 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * @see Please see http://de.php.net/manual/en/function.socket-connect.php#84465 for original code * @todo Rewrite the while() loop to a iterator to not let the software stay very long here */ - protected function connectToPeerByRecipientDataArray (array $recipientData) { + protected function connectToPeerByRecipientData (array $recipientData) { // Only call this if the connection is initialized by initConnection() - assert($this->isInitialized === true); + assert($this->isInitialized === TRUE); // Get current time $time = time(); @@ -227,7 +242,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc $timeout = $this->getConfigInstance()->getConfigEntry('socket_timeout_seconds'); // Debug output - $this->debugOutput('CONNECTION-HELPER: Trying to connect to ' . $recipientData[0] . ':' . $recipientData[1] . ' with socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' ...'); + self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Trying to connect to ' . $recipientData[0] . ':' . $recipientData[1] . ' with socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' ...'); // Try to connect until it is connected while ($isConnected = !@socket_connect($socketResource, $recipientData[0], $recipientData[1])) { @@ -239,7 +254,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc // Now, is that attempt within parameters? if ((time() - $time) >= $timeout) { // Didn't work within timeout - $isConnected = false; + $isConnected = FALSE; break; } // END - if @@ -247,13 +262,13 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc $this->idle(1000); } elseif ($socketError != 0) { // Stop on everything else pronto - $isConnected = false; + $isConnected = FALSE; break; } } // END - while // Is the peer connected? - if ($isConnected === true) { + if ($isConnected === TRUE) { // Connection is fully established here, so change the state. PeerStateFactory::createPeerStateInstanceByName('connected', $this); } else { @@ -315,12 +330,12 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc private function getRawDataFromPackageArray (array $packageData) { // Implode the package data array and fragement the resulting string, returns the final hash $finalHash = $this->getFragmenterInstance()->fragmentPackageArray($packageData, $this); - if ($finalHash !== true) { + if ($finalHash !== TRUE) { $this->currentFinalHash = $finalHash; } // END - if // Debug message - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: currentFinalHash=' . $this->currentFinalHash); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: currentFinalHash=' . $this->currentFinalHash); // Get the next raw data chunk from the fragmenter $rawDataChunk = $this->getFragmenterInstance()->getNextRawDataChunk($this->currentFinalHash); @@ -330,18 +345,18 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc $chunkData = array_values($rawDataChunk); // Is the required data there? - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: chunkHashes[]=' . count($chunkHashes) . ',chunkData[]=' . count($chunkData)); - //* NOISY-DEBUG: */ $this->debugOutput('chunkData='.print_r($chunkData,true)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: chunkHashes[]=' . count($chunkHashes) . ',chunkData[]=' . count($chunkData)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('chunkData='.print_r($chunkData, TRUE)); if ((isset($chunkHashes[0])) && (isset($chunkData[0]))) { // Remember this chunk as queued $this->queuedChunks[$chunkHashes[0]] = $chunkData[0]; // Return the raw data - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: Returning ' . strlen($chunkData[0]) . ' bytes from ' . __METHOD__ . ' ...'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Returning ' . strlen($chunkData[0]) . ' bytes from ' . __METHOD__ . ' ...'); return $chunkData[0]; } else { // Return zero string - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: Returning zero bytes from ' . __METHOD__ . '!'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Returning zero bytes from ' . __METHOD__ . '!'); return ''; } } @@ -368,6 +383,9 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc // The helper's state must be 'connected' $this->getStateInstance()->validatePeerStateConnected(); + // Reset serial number + $this->getFragmenterInstance()->resetSerialNumber(); + // Cache buffer length $bufferSize = $this->getConfigInstance()->getConfigEntry($this->getProtocol() . '_buffer_length'); @@ -378,12 +396,14 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc // Fill sending buffer with data while (strlen($dataStream) > 0) { + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: packageData=' . print_r($packageData, TRUE)); + // Convert the package data array to a raw data stream $dataStream = $this->getRawDataFromPackageArray($packageData); - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: Adding ' . strlen($dataStream) . ' bytes to the sending buffer ...'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Adding ' . strlen($dataStream) . ' bytes to the sending buffer ...'); $rawData .= $dataStream; } // END - while - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: rawData[' . strlen($rawData) . ']=' . $rawData); // Nothing to sent is bad news, so assert on it assert(strlen($rawData) > 0); @@ -391,6 +411,9 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc // Encode the raw data with our output-stream $encodedData = $this->getOutputStreamInstance()->streamData($rawData); + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: rawData()=' . strlen($rawData) . ',encodedData()=' . strlen($encodedData)); + // Calculate difference $this->diff = $bufferSize - strlen($encodedData); @@ -401,19 +424,22 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc $sentBytes = 0; // Deliver all data - while ($sentBytes !== false) { + while ($sentBytes !== FALSE) { // And deliver it - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: Sending out ' . strlen($encodedData) . ' bytes,bufferSize=' . $bufferSize . ',diff=' . $this->diff); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Sending out ' . strlen($encodedData) . ' bytes,bufferSize=' . $bufferSize . ',diff=' . $this->diff); + if ($this->diff >= 0) { // Send all out (encodedData is smaller than or equal buffer size) + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: MD5=' . md5(substr($encodedData, 0, ($bufferSize - $this->diff)))); $sentBytes = socket_write($socketResource, $encodedData, ($bufferSize - $this->diff)); } else { // Send buffer size out + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: MD5=' . md5(substr($encodedData, 0, $bufferSize))); $sentBytes = socket_write($socketResource, $encodedData, $bufferSize); } // If there was an error, we don't continue here - if ($sentBytes === false) { + if ($sentBytes === FALSE) { // Handle the error with a faked recipientData array $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0')); @@ -421,7 +447,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc throw new InvalidSocketException(array($this, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET); } elseif (($sentBytes == 0) && (strlen($encodedData) > 0)) { // Nothing sent means we are done - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: All sent! (LINE=' . __LINE__ . ')'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')'); break; } @@ -432,7 +458,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc $totalSentBytes += $sentBytes; // Cut out the last unsent bytes - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: Sent out ' . $sentBytes . ' of ' . strlen($encodedData) . ' bytes ...'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedData) . ' bytes ...'); $encodedData = substr($encodedData, $sentBytes); // Calculate difference again @@ -441,13 +467,13 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc // Can we abort? if (strlen($encodedData) <= 0) { // Abort here, all sent! - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: All sent! (LINE=' . __LINE__ . ')'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')'); break; } // END - if } // END - while // Return sent bytes - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: totalSentBytes=' . $totalSentBytes . ',diff=' . $this->diff); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: totalSentBytes=' . $totalSentBytes . ',diff=' . $this->diff); return $totalSentBytes; } @@ -457,11 +483,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * @return void */ protected final function markConnectionShuttedDown () { - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: ' . $this->__toString() . ' has been marked as shutted down'); - $this->shuttedDown = true; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: ' . $this->__toString() . ' has been marked as shutted down'); + $this->shuttedDown = TRUE; // And remove the (now invalid) socket - $this->setSocketResource(false); + $this->setSocketResource(FALSE); } /** @@ -470,7 +496,7 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * @return $shuttedDown Whether this connection is shutted down */ public final function isShuttedDown () { - //* NOISY-DEBUG: */ $this->debugOutput('CONNECTION: ' . $this->__toString() . ',shuttedDown=' . intval($this->shuttedDown)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: ' . $this->__toString() . ',shuttedDown=' . intval($this->shuttedDown)); return $this->shuttedDown; } @@ -483,10 +509,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * later debugging purposes. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void * @throws SocketConnectionException The connection attempts fails with a time-out */ - protected function socketErrorConnectionTimedOutHandler ($socketResource) { + protected function socketErrorConnectionTimedOutHandler ($socketResource, array $recipientData) { // Get socket error code for verification $socketError = socket_last_error($socketResource); @@ -505,10 +532,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * clear it for later debugging purposes. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void * @throws SocketConnectionException The connection attempts fails with a time-out */ - protected function socketErrorResourceUnavailableHandler ($socketResource) { + protected function socketErrorResourceUnavailableHandler ($socketResource, array $recipientData) { // Get socket error code for verification $socketError = socket_last_error($socketResource); @@ -527,10 +555,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * later debugging purposes. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void * @throws SocketConnectionException The connection attempts fails with a time-out */ - protected function socketErrorConnectionRefusedHandler ($socketResource) { + protected function socketErrorConnectionRefusedHandler ($socketResource, array $recipientData) { // Get socket error code for verification $socketError = socket_last_error($socketResource); @@ -549,10 +578,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * debugging purposes. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void * @throws SocketConnectionException The connection attempts fails with a time-out */ - protected function socketErrorNoRouteToHostHandler ($socketResource) { + protected function socketErrorNoRouteToHostHandler ($socketResource, array $recipientData) { // Get socket error code for verification $socketError = socket_last_error($socketResource); @@ -568,14 +598,15 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc /** * Handles socket error 'operation already in progress' which happens in - * method connectToPeerByRecipientDataArray() on timed out connection + * method connectToPeerByRecipientData() on timed out connection * attempts. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void * @throws SocketConnectionException The connection attempts fails with a time-out */ - protected function socketErrorOperationAlreadyProgressHandler ($socketResource) { + protected function socketErrorOperationAlreadyProgressHandler ($socketResource, array $recipientData) { // Get socket error code for verification $socketError = socket_last_error($socketResource); @@ -594,10 +625,11 @@ class BaseConnectionHelper extends BaseHubHelper implements Registerable, Protoc * passed on with non-blocking connections. * * @param $socketResource A valid socket resource + * @param $recipientData An array with two elements: 0=IP number, 1=port number * @return void */ - protected function socketErrorOperationInProgressHandler ($socketResource) { - $this->debugOutput('CONNECTION: Operation is now in progress, this is usual for non-blocking connections and is no bug.'); + protected function socketErrorOperationInProgressHandler ($socketResource, array $recipientData) { + self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __LINE__ . ']: Operation is now in progress, this is usual for non-blocking connections and is no bug.'); } }