<?php
/**
 * A general Handler
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 <http://www.gnu.org/licenses/>.
 */
class BaseNetworkPackageHandler extends BaseHandler {
	// Error codes
	const SOCKET_ERROR_UNKNOWN             = 'unknown_error';
	const SOCKET_ERROR_TRANSPORT_ENDPOINT  = 'transport_endpoint';
	const SOCKET_ERROR_UNHANDLED           = 'unhandled_package';
	const SOCKET_ERROR_EMPTY_DATA          = 'empty_data';
	const PACKAGE_ERROR_INVALID_DATA       = 'invalid_data';
	const PACKAGE_ERROR_INCOMPLETE_DATA    = 'incomplete_data';
	const PACKAGE_ERROR_INVALID_CONTENT    = 'invalid_content';
	const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error';
	const PACKAGE_LEVEL_CHECK_OKAY         = 'checked_package';

	/**
	 * 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);
	}

	/**
	 * 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?
		$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]
?>