<?php
/**
 * A Peer lookup table class
 *
 * @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 PeerStateLookupTable extends BaseLookupTable implements LookupablePeerState {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this class
	 *
	 * @return	$tableInstance	An instance of a Lookupable class
	 */
	public final static function createPeerStateLookupTable () {
		// Get new instance
		$tableInstance = new PeerStateLookupTable();

		// Get a database wrapper instance
		$wrapperInstance = ObjectFactory::createObjectByConfiguredName('peer_state_lookup_db_wrapper_class');

		// Set it for later re-use
		$tableInstance->setWrapperInstance($wrapperInstance);

		// Return the prepared instance
		return $tableInstance;
	}

	/**
	 * Checks wether given 'sender' is a new peer
	 *
	 * @param	$packageData	Raw package data
	 * @return	$isNewPeer		Wether 'sender' is a new peer to this node
	 */
	public function isSenderNewPeer (array $packageData) {
		// Get our wrapper instance and ask for it
		$isNewPeer = $this->getWrapperInstance()->isSenderNewPeer($packageData);

		// Return it
		return $isNewPeer;
	}

	/**
	 * Registers a peer with given package data. We use the session id from it
	 *
	 * @param	$packageData		Valid raw package data
	 * @param	$socketResource		A valid socket resource
	 * @return	void
	 */
	public function registerPeerByPackageData (array $packageData, $socketResource) {
		// Just handle it over
		$this->getWrapperInstance()->registerPeerByPackageData($packageData, $socketResource);
	}

	/**
	 * Registers the given peer state and raw package data
	 *
	 * @param	$stateInstance	A PeerStateable class instance
	 * @param	$packageData	Valid package data array
	 * @return	void
	 */
	public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
		die(__METHOD__."\n");
	}

	/**
	 * Purges old entries of given socket resource. We use the IP address from that resource.
	 *
	 * @param	$socketResource		A valid socket resource
	 * @return	void
	 */
	public function purgeOldEntriesBySocketResource ($socketResource) {
		// Just handle it over
		$this->getWrapperInstance()->purgeOldEntriesBySocketResource($socketResource);
	}
}

// [EOF]
?>