framework/main/classes/listener/class_

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