inc/main/classes/listener/class_

   1 <?php
   2 /**
   3  * A ??? 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 ???Listener 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          * @param       $nodeInstance           A NodeHelper instance
  39          * @return      $listenerInstance       An instance a prepared listener class
  40          */
  41         public final static function create???Listener (NodeHelper $nodeInstance) {
  42                 // Get new instance
  43                 $listenerInstance = new ???Listener();
  44
  45                 // Set the application instance
  46                 $listenerInstance->setNodeInstance($nodeInstance);
  47
  48                 // Return the prepared instance
  49                 return $listenerInstance;
  50         }
  51
  52         /**
  53          * Initializes the listener by setting up the required socket server
  54          *
  55          * @return      void
  56          * @todo        0% done
  57          */
  58         public function initListener() {
  59                 $this->partialStub('Need to implement this method.');
  60         }
  61
  62         /**
  63          * "Listens" for incoming network packages
  64          *
  65          * @return      void
  66          * @todo        0% done
  67          */
  68         public function doListen() {
  69                 $this->partialStub('Need to implement this method.');
  70         }
  71 }
  72
  73 // [EOF]
  74 ?>