3 * An interface for peer-state lookup tables
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 LookupablePeerState extends Lookupable {
26 * Checks wether given 'sender' is a new peer
28 * @param $packageData Raw package data
29 * @return $isNewPeer Wether 'sender' is a new peer to this node
31 function isSenderNewPeer (array $packageData);
34 * Registers a peer with given package data. We use the session id from it
36 * @param $packageData Valid raw package data
37 * @param $socketResource A valid socket resource
40 function registerPeerByPackageData (array $packageData, $socketResource);
43 * Registers the given peer state and raw package data
45 * @param $stateInstance A PeerStateable class instance
46 * @param $packageData Valid package data array
49 function registerPeerState (PeerStateable $stateInstance, array $packageData);
52 * Purges old entries of given socket resource. We use the IP address from that resource.
54 * @param $socketResource A valid socket resource
57 function purgeOldEntriesBySocketResource ($socketResource);