* @version 0.0.0 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ class BaseNetworkPackageHandler extends BaseHandler { // Error codes: // - Socket raw data stream errors const SOCKET_ERROR_UNKNOWN = 'unknown_error'; // Unknown error (should not happen) const SOCKET_ERROR_TRANSPORT_ENDPOINT = 'transport_endpoint'; // Transport endpoint has closed const SOCKET_ERROR_EMPTY_DATA = 'empty_data'; // Other peer has sent nothing const SOCKET_ERROR_INVALID_BASE64_MODULO = 'base64_modulo'; // Length is not modulo 4 const SOCKET_ERROR_INVALID_BASE64_MESSAGE = 'base64_message'; // Raw data is not Base64-encoded const SOCKET_ERROR_UNHANDLED = 'unhandled_package'; // Unhandled raw data (not bad) // - Package errors const PACKAGE_ERROR_INVALID_DATA = 'invalid_data'; // Invalid data in package found const PACKAGE_ERROR_INCOMPLETE_DATA = 'incomplete_data'; // Incomplete data sent (e.g. field is missing) const PACKAGE_ERROR_INVALID_CONTENT = 'invalid_content'; // Content is invalid (e.g. not well-formed) const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us const PACKAGE_LEVEL_CHECK_OKAY = 'checked_package'; // Package is fine /** * Error code from socket */ private $errorCode = -1; /** * Protected constructor * * @param $className Name of the class * @return void */ protected function __construct ($className) { // Call parent constructor parent::__construct($className); // Get an input stream instance $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class', array($this)); // Set it in this network-package handler $this->setInputStreamInstance($streamInstance); } /** * Checks wether the 'recipient' field matches our own address:port * combination. * * @param $packageData Raw package data * @return $matches Wether it matches */ protected function ifRecipientMatchesOwnAddress (array $packageData) { // Construct own address first, $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this); // Does it match? // @TODO Numeric or alpha-numeric index? $matches = ($ownAddress === $packageData[NetworkPackage::INDEX_PACKAGE_RECIPIENT]); // Return result return $matches; } /** * Setter for error code * * @param $errorCode The error code we shall set * @return void */ protected final function setErrorCode ($errorCode) { $this->errorCode = $errorCode; } /** * Getter for error code * * @return $errorCode The error code */ public final function getErrorCode () { return $this->errorCode; } } // [EOF] ?>