inc/main/interfaces/listener/class_Listenable.php

   1 <?php
   2 /**
   3  * An interface for listeners
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 interface Listenable extends FrameworkInterface {
  25         /**
  26          * Initializes the listener by setting up the required socket server
  27          *
  28          * @return      void
  29          */
  30         function initListener();
  31
  32         /**
  33          * "Listens" for incoming network packages
  34          *
  35          * @return      void
  36          */
  37         function doListen();
  38
  39         /**
  40          * Checks whether the listener would accept the given package data array
  41          *
  42          * @param       $packageData    Raw package data
  43          * @return      $accepts                Whether this listener does accept
  44          */
  45         function ifListenerAcceptsPackageData (array $packageData);
  46
  47         /**
  48          * Monitors incoming raw data from the handler and transfers it to the
  49          * given receiver instance.
  50          *
  51          * @return      void
  52          */
  53         function monitorIncomingRawData ();
  54
  55         /**
  56          * Getter for listen address
  57          *
  58          * @return      $listenAddress  The address this listener should listen on
  59          */
  60         function getListenAddress ();
  61
  62         /**
  63          * Getter for listen port
  64          *
  65          * @return      $listenPort             The port this listener should listen on
  66          */
  67         function getListenPort ();
  68
  69         /**
  70          * Getter for connection type
  71          *
  72          * @return      $connectionType         Connection type for this listener
  73          */
  74         function getConnectionType ();
  75
  76         /**
  77          * Getter for peer pool instance
  78          *
  79          * @return      $poolInstance   The peer pool instance we shall set
  80          */
  81         function getPoolInstance ();
  82
  83 }