3 namespace CoreFramework\Listener;
5 // Load framework stuff
6 use CoreFramework\Generic\FrameworkInterface;
9 * An interface for listeners
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface Listenable extends FrameworkInterface {
32 * Initializes the listener by setting up the required socket server
36 function initListener();
39 * "Listens" for incoming network packages
46 * Checks whether the listener would accept the given package data array
48 * @param $packageData Raw package data
49 * @return $accepts Whether this listener does accept
51 function ifListenerAcceptsPackageData (array $packageData);
54 * Monitors incoming raw data from the handler and transfers it to the
55 * given receiver instance.
59 function monitorIncomingRawData ();
62 * Getter for listen address
64 * @return $listenAddress The address this listener should listen on
66 function getListenAddress ();
69 * Getter for listen port
71 * @return $listenPort The port this listener should listen on
73 function getListenPort ();
76 * Getter for connection type
78 * @return $connectionType Connection type for this listener
80 function getConnectionType ();
83 * Getter for peer pool instance
85 * @return $poolInstance The peer pool instance we shall set
87 function getPoolInstance ();