3 * A TCP network package handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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 TcpNetworkPackageHandler extends BaseNetworkPackageHandler 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 createTcpNetworkPackageHandler () {
45 $handlerInstance = new TcpNetworkPackageHandler();
47 // Init stacker instance for processed raw data
48 $stackerInstance = ObjectFactory::createObjectByConfiguredName('
49 // Return the prepared instance
50 return $handlerInstance;
54 * Processes raw data from given resource. This is mostly useful for TCP
55 * package handling and is implemented in the TcpListener class
57 * @param $resource A valid resource identifier
60 public function processResourceRawData ($resource) {
62 if (!is_resource($resource)) {
64 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
67 // Reset error code to unhandled
68 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
74 //* NOISY-DEBUG: */ $this->debugOutput('HANDLER: Handling TCP package from peer ' . $resource);
77 * Read the raw data from socket. If you change PHP_BINARY_READ to
78 * PHP_NORMAL_READ, this line will endless block. We only have
79 * simultanous threads and no real threads.
81 $rawData = socket_read($resource, $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_BINARY_READ);
83 // Debug output of read data length
84 //* NOISY-DEBUG: */ $this->debugOutput('LISTENER: rawData[]=' . strlen($rawData));
87 if (($rawData === false) || (socket_last_error($resource) > 0)) {
88 // Network error or connection lost
89 $this->setErrorCode(socket_last_error($resource));
90 } elseif (empty($rawData)) {
91 // The peer did send nothing to us
92 $this->setErrorCode(self::SOCKET_ERROR_EMPTY_DATA);
95 * Low-level checks of the raw data went all fine, we can now
96 * decode the raw data. This may still fail because of invalid
99 $decodedData = $this->getInputStreamInstance()->streamData($rawData);
102 // Add the (maybe above decoded) data and error code to the stacker