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

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