<?php
/**
 * An interface for node-list (database) wrapper
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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/>.
 */
interface NodeListWrapper extends FrameworkInterface {
	/**
	 * Resolves a session id into an ip:port combination
	 *
	 * @param	$sessionId	A valid session id
	 * @param	$protocol	Name of the protocol (TCP/UDP)
	 * @return	$recipient	Recipient as ip:port combination
	 */
	function resolveIpPortBySessionId ($sessionId, $protocol);

	/**
	 * Resolves a ip:port combination into a session id
	 *
	 * @param	$ipPort		Ip:port combination
	 * @param	$protocol	Name of the used protocol (TCP/UDP)
	 * @return	$sessionId	A valid session id
	 */
	function resolveSessionIdByIpPort ($ipPort, $protocol);

	/**
	 * Registeres a node by given message data.
	 *
	 * @param	$messageData		An array of all message data
	 * @param	$handlerInstance	An instance of a HandleableMessage class
	 * @return	void
	 */
	function registerNodeByMessageData (array $messageData, HandleableMessage $handlerInstance);

	/**
	 * Updates an existing entry in node list
	 *
	 * @param	$messageData		An array of all message data
	 * @param	$handlerInstance	An instance of a HandleableMessage class
	 * @return	void
	 */
	function updateNodeByMessageData (array $messageData, HandleableMessage $handlerInstance);
}

// [EOF]
?>