3 * A general Handler for raw data from sockets
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 BaseRawDataHandler extends BaseHandler {
26 // - Socket raw data stream errors
27 const SOCKET_ERROR_UNKNOWN = 'unknown_error'; // Unknown error (should not happen)
28 const SOCKET_ERROR_TRANSPORT_ENDPOINT = 'transport_endpoint'; // Transport endpoint has closed
29 const SOCKET_ERROR_EMPTY_DATA = 'empty_data'; // Other peer has sent nothing
30 const SOCKET_ERROR_INVALID_BASE64_MODULO = 'base64_modulo'; // Length is not modulo 4
31 const SOCKET_ERROR_INVALID_BASE64_MESSAGE = 'base64_message'; // Raw data is not Base64-encoded
32 const SOCKET_ERROR_UNHANDLED = 'unhandled_package'; // Unhandled raw data (not bad)
33 const SOCKET_ERROR_CONNECTION_REFUSED = 'connection_refused'; // The name says it: connection refused
34 const SOCKET_ERROR_CONNECTION_TIMED_OUT = 'connection_timed_out'; // The name says it: connection attempt has timed-out
35 const SOCKET_ERROR_OPERATION_IN_PROGRESS = 'operation_in_progress'; // 'Operation now in progress'
36 const SOCKET_ERROR_OPERATION_ALREADY_PROGRESS = 'operation_already_progress'; // 'Operation already in progress'
37 const SOCKET_ERROR_RESOURCE_UNAVAILABLE = 'resource_unavailable'; // 'Resource temporary unavailable'
38 const SOCKET_ERROR_NO_ROUTE_TO_HOST = 'no_route_to_host'; // The name says it: no route to host
39 const SOCKET_CONNECTED = 'connected'; // Nothing errorous happens, socket is connected
42 const PACKAGE_ERROR_INVALID_DATA = 'invalid_data'; // Invalid data in package found
43 const PACKAGE_ERROR_INCOMPLETE_DATA = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
44 const PACKAGE_ERROR_INVALID_CONTENT = 'invalid_content'; // Content is invalid (e.g. not well-formed)
45 const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us
46 const PACKAGE_LEVEL_CHECK_OKAY = 'checked_package'; // Package is fine
49 const PACKAGE_DECODED_DATA = 'decoded_data';
50 const PACKAGE_ERROR_CODE = 'error_code';
53 * Stacker for decoded data
55 const STACKER_NAME_DECODED_DATA = 'decoded_data';
58 * Error code from socket
60 private $errorCode = -1;
63 * Protected constructor
65 * @param $className Name of the class
68 protected function __construct ($className) {
69 // Call parent constructor
70 parent::__construct($className);
72 // Set error code to 'unknown'
73 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
75 // Get an input stream instance
76 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class', array($this));
78 // Set it in this network-package handler
79 $this->setInputStreamInstance($streamInstance);
81 // Init stacker instance for processed raw data
82 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
84 // Remember this in this package handler
85 $this->setStackerInstance($stackerInstance);
92 * Initializes the stacker for raw data
96 protected function initStacker () {
97 $this->getStackerInstance()->initStacker(self::STACKER_NAME_DECODED_DATA);
101 * Adds given decoded data to the raw data stacker
103 * @param $decodedData Decoded data from the socket resource
106 protected function addDecodedDataToStacker ($decodedData) {
108 * Add the deocoded data and error code to the stacker so other classes
109 * (e.g. NetworkPackage) can "pop" it from the stacker.
111 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_DATA, array(
112 self::PACKAGE_DECODED_DATA => $decodedData,
113 self::PACKAGE_ERROR_CODE => $this->getErrorCode()
118 * Checks whether decoded data is pending for further processing.
120 * @return $isPending Whether decoded data is pending
122 public function isDecodedDataPending () {
123 // Does the stacker have some entries (not empty)?
124 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_DATA));
131 * "Getter" for next decoded data from the stacker
133 * @return $decodedData Decoded data from the stacker
135 public function getNextDecodedData () {
136 // "Pop" the decoded data from the stacker
137 $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_DATA);
144 * Checks whether the 'recipient' field matches our own address:port
147 * @param $packageData Raw package data
148 * @return $matches Whether it matches
149 * @todo This method will be moved to a better place
151 protected function ifRecipientMatchesOwnAddress (array $packageData) {
152 // Construct own address first
153 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
156 $matches = ($ownAddress === $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
163 * Setter for error code
165 * @param $errorCode The error code we shall set
168 public final function setErrorCode ($errorCode) {
169 $this->errorCode = $errorCode;
173 * Getter for error code
175 * @return $errorCode The error code
177 public final function getErrorCode () {
178 return $this->errorCode;