application/hub/main/handler/network/tcp/class_TcpRawDataHandler.php

   1 <?php
   2 /**
   3  * A TCP raw data handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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.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 TcpRawDataHandler extends BaseRawDataHandler implements Networkable {
  25         /**
  26          * Last socket error (default: Success)
  27          */
  28         private $lastSocketError = 0;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set handler name
  40                 $this->setHandlerName('tcp');
  41         }
  42
  43         /**
  44          * Creates an instance of this class
  45          *
  46          * @return      $handlerInstance        An instance of a Networkable class
  47          */
  48         public static final function createTcpRawDataHandler () {
  49                 // Get new instance
  50                 $handlerInstance = new TcpRawDataHandler();
  51
  52                 // Return the prepared instance
  53                 return $handlerInstance;
  54         }
  55
  56         /**
  57          * Processes raw data from given resource. This is mostly useful for TCP
  58          * package handling and is implemented in the TcpListener class
  59          *
  60          * @param       $resource       A valid socket resource array
  61          * @return      void
  62          */
  63         public function processRawDataFromResource (array $socketArray) {
  64                 // Check the resource
  65                 if ((!isset($socketArray[BasePool::SOCKET_ARRAY_RESOURCE])) || (!is_resource($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]))) {
  66                         // Throw an exception
  67                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
  68                 } // END - if
  69
  70                 // Reset error code to unhandled
  71                 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
  72
  73                 // Debug message
  74                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Handling TCP package from resource=' . $socketArray[BasePool::SOCKET_ARRAY_RESOURCE] . ',type=' . $socketArray[BasePool::SOCKET_ARRAY_CONN_TYPE] . ',last error=' . socket_strerror($this->lastSocketError));
  75
  76                 /*
  77                  * Read the raw data from socket. If you change PHP_BINARY_READ to
  78                  * PHP_NORMAL_READ, this line will endless block. This script does only
  79                  * provide simultanous threads, not real.
  80                  */
  81                 $rawData = socket_read($socketArray[BasePool::SOCKET_ARRAY_RESOURCE], $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_BINARY_READ);
  82
  83                 // Get socket error code back
  84                 $this->lastSocketError = socket_last_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]);
  85
  86                 // Debug output of read data length
  87                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: rawData[' . gettype($rawData) . ']=' . strlen($rawData) . ',MD5=' . md5($rawData) . ',resource=' . $socketArray[BasePool::SOCKET_ARRAY_RESOURCE] . ',error=' . socket_strerror($this->lastSocketError));
  88                 //* NOISY-DEBUG: */ if ($rawData !== FALSE) self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: rawData=' . $rawData);
  89
  90                 // Is it valid?
  91                 if ($this->lastSocketError == 11) {
  92                         // Debug message
  93                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Ignoring error 11 (Resource temporary unavailable) from socket resource=' . $socketArray[BasePool::SOCKET_ARRAY_RESOURCE]);
  94
  95                         /*
  96                          * Error code 11 (Resource temporary unavailable) can be safely
  97                          * ignored on non-blocking sockets. The socket is currently not
  98                          * sending any data.
  99                          */
 100                          socket_clear_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]);
 101
 102                          // Skip any further processing
 103                          return;
 104                 } elseif (($rawData === FALSE) || ($this->lastSocketError > 0)) {
 105                         // Network error or connection lost
 106                         $this->setErrorCode($this->lastSocketError);
 107                 } elseif (empty($rawData)) {
 108                         // The peer did send nothing to us which is now being ignored
 109                         return;
 110                 } else {
 111                         /*
 112                          * All is fine at this point. So it is okay to add the raw data to
 113                          * the stacker. Here it doesn't matter if the raw data is a
 114                          * well-formed BASE64-encoded message with start and markers. This
 115                          * will be checked later on.
 116                          */
 117                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . strlen($rawData) . ' bytes to stacker ...');
 118                         $this->addRawDataToStacker($rawData);
 119                 }
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>