Also this ... :-/ Getting late here.

[hub.git] / application / hub / interfaces / listener / class_Listenable.php

diff --git a/application/hub/interfaces/listener/class_Listenable.php b/application/hub/interfaces/listener/class_Listenable.php
index a8e9ed30bb2e9181ee4ca710869de720b301d256..d453324ebfa09473683a43b2defc0194bebdd945 100644 (file)
--- 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 <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @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 <http://www.gnu.org/licenses/>.
  */
-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]
 ?>