3 * An interface for node-list (database) wrapper
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 interface NodeListWrapper extends FrameworkInterface {
26 * Resolves a session id into an ip:port combination
28 * @param $sessionId A valid session id
29 * @param $protocol Name of the protocol (TCP/UDP)
30 * @return $recipient Recipient as ip:port combination
32 function resolveIpPortBySessionId ($sessionId, $protocol);
35 * Resolves a ip:port combination into a session id
37 * @param $ipPort Ip:port combination
38 * @param $protocol Name of the used protocol (TCP/UDP)
39 * @return $sessionId A valid session id
41 function resolveSessionIdByIpPort ($ipPort, $protocol);
44 * Registeres a node by given message data.
46 * @param $messageData An array of all message data
47 * @param $handlerInstance An instance of a HandleableMessage class
50 function registerNodeByMessageData (array $messageData, HandleableMessage $handlerInstance);
53 * Updates an existing entry in node list
55 * @param $messageData An array of all message data
56 * @param $handlerInstance An instance of a HandleableMessage class
59 function updateNodeByMessageData (array $messageData, HandleableMessage $handlerInstance);