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

   1 <?php
   2 /**
   3  * A TCP network package handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 TcpNetworkPackageHandler extends BaseNetworkPackageHandler 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 createTcpNetworkPackageHandler () {
  44                 // Get new instance
  45                 $handlerInstance = new TcpNetworkPackageHandler();
  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 resource identifier
  56          * @return      void
  57          */
  58         public function processResourceRawData ($resource) {
  59                 // Check the resource
  60                 if (!is_resource($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: */ $this->debugOutput('HANDLER: Handling TCP package from peer ' . $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. We only have
  77                  * simultanous threads and no real threads.
  78                  */
  79                 $rawData = socket_read($resource, $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_BINARY_READ);
  80
  81                 // Debug output of read data length
  82                 //* NOISY-DEBUG: */ $this->debugOutput('LISTENER: rawData[]=' . strlen($rawData));
  83
  84                 // Is it valid?
  85                 if (($rawData === false) || (socket_last_error($resource) > 0)) {
  86                         // Network error or connection lost
  87                         $this->setErrorCode(socket_last_error($resource));
  88                 } elseif (empty($rawData)) {
  89                         // The peer did send nothing to us
  90                         $this->setErrorCode(self::SOCKET_ERROR_EMPTY_DATA);
  91                 } else {
  92                         /*
  93                          * Low-level checks of the raw data went all fine, we can now
  94                          * decode the raw data. This may still fail because of invalid
  95                          * encoded data.
  96                          */
  97                         $decodedData = $this->getInputStreamInstance()->streamData($rawData);
  98                 }
  99
 100                 // Add the (maybe above decoded) data and error code to the stacker
 101                 $this->addRawDataToStacker($decodedData);
 102         }
 103 }
 104
 105 // [EOF]
 106 ?>