inc/main/classes/listener/socket/class_SocketFileListener.php

   1 <?php
   2 /**
   3  * A file-based socket listener
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 class SocketFileListener extends BaseListener implements Listenable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $listenerInstance       An instance a prepared listener class
  39          */
  40         public final static function createSocketFileListener () {
  41                 // Get new instance
  42                 $listenerInstance = new SocketFileListener();
  43
  44                 // Return the prepared instance
  45                 return $listenerInstance;
  46         }
  47
  48         /**
  49          * Initializes the listener by setting up the required socket server
  50          *
  51          * @return      void
  52          * @todo        0% done
  53          */
  54         public function initListener() {
  55                 $this->partialStub('Need to implement this method.');
  56         }
  57
  58         /**
  59          * "Listens" for incoming network packages
  60          *
  61          * @return      void
  62          * @todo        0% done
  63          */
  64         public function doListen() {
  65                 $this->partialStub('Need to implement this method.');
  66         }
  67
  68         /**
  69          * Checks whether the listener would accept the given package data array
  70          *
  71          * @param       $packageData    Raw package data
  72          * @return      $accepts                Whether this listener does accept
  73          */
  74         public function ifListenerAcceptsPackageData (array $packageData) {
  75                 $this->partialStub('Need to implement this method.') {
  76         }
  77
  78         /**
  79          * Monitors incoming raw data from the handler and transfers it to the
  80          * given receiver instance.
  81          *
  82          * @return      void
  83          */
  84         public function monitorIncomingRawData () {
  85                 $this->partialStub('Need to implement this method.') {
  86         }
  87
  88         /**
  89          * Getter for listen address
  90          *
  91          * @return      $listenAddress  The address this listener should listen on
  92          */
  93         public function getListenAddress () {
  94                 $this->partialStub('Need to implement this method.') {
  95         }
  96
  97         /**
  98          * Getter for listen port
  99          *
 100          * @return      $listenPort             The port this listener should listen on
 101          */
 102         public function getListenPort () {
 103                 $this->partialStub('Need to implement this method.') {
 104         }
 105
 106         /**
 107          * Getter for connection type
 108          *
 109          * @return      $connectionType         Connection type for this listener
 110          */
 111         public function getConnectionType () {
 112                 $this->partialStub('Need to implement this method.') {
 113         }
 114
 115         /**
 116          * Getter for peer pool instance
 117          *
 118          * @return      $poolInstance   The peer pool instance we shall set
 119          */
 120         public function getPoolInstance () {
 121                 $this->partialStub('Need to implement this method.') {
 122         }
 123 }
 124
 125 // [EOF]
 126 ?>