3 * A TCP network package handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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__);
36 * Creates an instance of this class
38 * @return $handlerInstance An instance of a Networkable class
40 public final static function createTcpNetworkPackageHandler () {
42 $handlerInstance = new TcpNetworkPackageHandler();
44 // Initialize new resolver instance
45 $resolverInstance = ObjectFactory::createObjectByConfiguredName('network_state_resolver_class');
47 // Set it in this class
48 $handlerInstance->setResolverInstance($resolverInstance);
50 // Return the prepared instance
51 return $handlerInstance;
55 * Processes a package from given resource. This is mostly useful for TCP
56 * package handling and is implemented in the TcpListener class
58 * @param $resource A valid resource identifier
60 * @throws InvalidResourceException If the given resource is invalid
63 public function processResourcePackage ($resource) {
65 if (!is_resource($resource)) {
67 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
70 // Reset error code to unhandled
71 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
74 $this->debugOutput('HANDLER: Handling TCP package from peer ' . $resource);
76 // Read the raw data from socket
77 $rawData = socket_read($resource, 1500, PHP_NORMAL_READ);
80 if (($rawData === false) || (socket_last_error($resource) > 0)) {
81 // Network error or connection lost
82 $this->setErrorCode(socket_last_error($resource));
83 } elseif (empty($rawData)) {
84 // The peer did send nothing to us
85 $this->setErrorCode(self::SOCKET_ERROR_EMPTY_DATA);
86 } elseif (!$this->isPackageDataValid($rawData)) {
87 // Invalid package data
88 $this->setErrorCode(self::PACKAGE_ERROR_INVALID_DATA);
90 // Low-level checks are all green
91 $this->setErrorCode(self::PACKAGE_LEVEL_CHECK_OKAY);
94 // Get a state from the resolver for this package
95 $stateInstance = $this->getResolverInstance()->resolveStateByPackage($this, $rawData);
96 die('UNFINISHED:'.$stateInstance->__toString());