3 * A TCP raw data handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class TcpRawDataHandler extends BaseRawDataHandler implements Networkable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('tcp');
39 * Creates an instance of this class
41 * @return $handlerInstance An instance of a Networkable class
43 public static final function createTcpRawDataHandler () {
45 $handlerInstance = new TcpRawDataHandler();
47 // Return the prepared instance
48 return $handlerInstance;
52 * Processes raw data from given resource. This is mostly useful for TCP
53 * package handling and is implemented in the TcpListener class
55 * @param $resource A valid socket resource array
58 public function processRawDataFromResource (array $socketArray) {
60 if ((!isset($socketArray[BasePool::SOCKET_ARRAY_RESOURCE])) || (!is_resource($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]))) {
62 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
65 // Reset error code to unhandled
66 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
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])));
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.
79 $rawData = socket_read($socketArray[BasePool::SOCKET_ARRAY_RESOURCE], $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_BINARY_READ);
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])));
85 if (socket_last_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]) == 11) {
87 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-HANDLER: Ignoring error 11 (Resource temporary unavailable) from socket resource=' . $socketArray[BasePool::SOCKET_ARRAY_RESOURCE]);
90 * Error code 11 (Resource temporary unavailable) can be safely
91 * ignored on non-blocking sockets. The socket is currently not
94 socket_clear_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]);
96 // Skip any further processing
98 } elseif (($rawData === false) || (socket_last_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]) > 0)) {
99 // Network error or connection lost
100 $this->setErrorCode(socket_last_error($socketArray[BasePool::SOCKET_ARRAY_RESOURCE]));
101 } elseif (empty($rawData)) {
102 // The peer did send nothing to us which is now being ignored
106 * Low-level checks of the raw data went all fine, now decode the
107 * raw data. This may still fail because of invalid encoded data.
109 $decodedData = $this->getInputStreamInstance()->streamData($rawData);
112 // Add the (maybe above decoded) data to the stacker
113 $this->addDecodedDataToStacker($decodedData);