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 // Initialize new resolver instance
48 $resolverInstance = ObjectFactory::createObjectByConfiguredName('network_state_resolver_class');
50 // Set it in this class
51 $handlerInstance->setResolverInstance($resolverInstance);
53 // Return the prepared instance
54 return $handlerInstance;
58 * Processes a package from given resource. This is mostly useful for TCP
59 * package handling and is implemented in the TcpListener class
61 * @param $resource A valid resource identifier
63 * @todo We need to handle the raw data over to the NetworkPackage class if the state if fine
65 public function processResourcePackage ($resource) {
67 if (!is_resource($resource)) {
69 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
72 // Init package data array
73 $packageData = array();
75 // Reset error code to unhandled
76 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
79 $this->debugOutput('HANDLER: Handling TCP package from peer ' . $resource);
81 // Read the raw data from socket
82 $rawData = socket_read($resource, $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_BINARY_READ);
84 // Debug output of read data length
85 $this->debugOutput('rawData[]=' . strlen($rawData));
88 if (($rawData === false) || (socket_last_error($resource) > 0)) {
89 // Network error or connection lost
90 $this->setErrorCode(socket_last_error($resource));
91 } elseif (empty($rawData)) {
92 // The peer did send nothing to us
93 $this->setErrorCode(self::SOCKET_ERROR_EMPTY_DATA);
96 // Get a state from the resolver for this package data array
97 $stateInstance = $this->getResolverInstance()->resolveStateByPackage($this, $packageData, $resource);
98 die('UNFINISHED:'.$stateInstance->__toString()."\n");