X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Finterfaces%2Flistener%2Fclass_Listenable.php;h=d453324ebfa09473683a43b2defc0194bebdd945;hb=01990c1e9b49954ce85c31456167705184572c8d;hp=a8e9ed30bb2e9181ee4ca710869de720b301d256;hpb=15585567c2714b3a3072fab8b1a8cb5d5c259f7e;p=hub.git diff --git a/application/hub/interfaces/listener/class_Listenable.php b/application/hub/interfaces/listener/class_Listenable.php index a8e9ed30b..d453324eb 100644 --- a/application/hub/interfaces/listener/class_Listenable.php +++ b/application/hub/interfaces/listener/class_Listenable.php @@ -2,11 +2,11 @@ /** * An interface for listeners * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.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 @@ -21,14 +21,65 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -interface Listenable { +interface Listenable extends FrameworkInterface { /** * Initializes the listener by setting up the required socket server * * @return void */ function initListener(); + + /** + * "Listens" for incoming network packages + * + * @return void + */ + function doListen(); + + /** + * Checks whether the listener would accept the given package data array + * + * @param $packageData Raw package data + * @return $accepts Whether this listener does accept + */ + function ifListenerAcceptsPackageData (array $packageData); + + /** + * Monitors incoming raw data from the handler and transfers it to the + * given receiver instance. + * + * @return void + */ + function monitorIncomingRawData (); + + /** + * Getter for listen address + * + * @return $listenAddress The address this listener should listen on + */ + function getListenAddress (); + + /** + * Getter for listen port + * + * @return $listenPort The port this listener should listen on + */ + function getListenPort (); + + /** + * Getter for connection type + * + * @return $connectionType Connection type for this listener + */ + function getConnectionType (); + + /** + * Getter for peer pool instance + * + * @return $poolInstance The peer pool instance we shall set + */ + function getPoolInstance (); } -// +// [EOF] ?>