framework/main/classes/listener/class_

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Listener\!!!;
   4
   5 // Import framework stuff
   6 use CoreFramework\Listener\BaseListener;
   7 use CoreFramework\Listener\Listenable;
   8
   9 /**
  10  * A ??? listener
  11  *
  12  * @author              Roland Haeder <webmaster@ship-simu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.ship-simu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class ???Listener extends BaseListener implements Listenable {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40
  41                 // Set the protocol to !!!
  42                 $this->setProtocolName('!!!');
  43         }
  44
  45         /**
  46          * Creates an instance of this class
  47          *
  48          * @return      $listenerInstance       An instance a prepared listener class
  49          */
  50         public final static function create???Listener () {
  51                 // Get new instance
  52                 $listenerInstance = new ???Listener();
  53
  54                 // Return the prepared instance
  55                 return $listenerInstance;
  56         }
  57
  58         /**
  59          * Initializes the listener by setting up the required socket server
  60          *
  61          * @return      void
  62          * @todo        0% done
  63          */
  64         public function initListener() {
  65                 $this->partialStub('Need to implement this method.');
  66         }
  67
  68         /**
  69          * "Listens" for incoming network packages
  70          *
  71          * @return      void
  72          * @todo        0% done
  73          */
  74         public function doListen() {
  75                 $this->partialStub('Need to implement this method.');
  76         }
  77
  78         /**
  79          * Checks whether the listener would accept the given package data array
  80          *
  81          * @param       $packageData    Raw package data
  82          * @return      $accepts                Whether this listener does accept
  83          */
  84         public function ifListenerAcceptsPackageData (array $packageData) {
  85                 $this->partialStub('Need to implement this method.') {
  86         }
  87
  88         /**
  89          * Monitors incoming raw data from the handler and transfers it to the
  90          * given receiver instance.
  91          *
  92          * @return      void
  93          */
  94         public function monitorIncomingRawData () {
  95                 $this->partialStub('Need to implement this method.') {
  96         }
  97
  98         /**
  99          * Getter for connection type
 100          *
 101          * @return      $connectionType         Connection type for this listener
 102          */
 103         public function getConnectionType () {
 104                 $this->partialStub('Need to implement this method.') {
 105         }
 106
 107 }