application/hub/main/listener/tcp/decorators/class_ClientTcpListenerDecorator.php

   1 <?php
   2 /**
   3  * A decorator for the TcpListener to communicate to peers
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 ClientTcpListenerDecorator extends BaseListenerDecorator 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                 // Set listener type
  35                 $this->setListenerType('peer');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $listenerInstance       A Listener instance
  42          * @return      $decoratorInstance      An instance a prepared listener decorator class
  43          */
  44         public static final function createClientTcpListenerDecorator (Listenable $listenerInstance) {
  45                 // Get new instance
  46                 $decoratorInstance = new ClientTcpListenerDecorator();
  47
  48                 // Set the application instance
  49                 $decoratorInstance->setListenerInstance($listenerInstance);
  50
  51                 // Return the prepared instance
  52                 return $decoratorInstance;
  53         }
  54
  55         /**
  56          * Initializes the listener by setting up the required socket server
  57          *
  58          * @return      void
  59          */
  60         public function initListener () {
  61                 $this->partialStub('WARNING: This method should not be called.');
  62         }
  63
  64         /**
  65          * "Listens" for incoming network packages
  66          *
  67          * @return      void
  68          */
  69         public function doListen () {
  70                 // Handle generic TCP package
  71                 $this->getListenerInstance()->doListen();
  72
  73                 // Handle peer TCP package
  74                 $this->partialStub('Need to handle peer TCP package.');
  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                 // Get a tags instance
  85                 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
  86
  87                 // So is the package accepted with this listener?
  88                 $accepts = $tagsInstance->ifPackageDataIsAcceptedByListener($packageData, $this);
  89
  90                 // Return the result
  91                 return $accepts;
  92         }
  93 }
  94
  95 // [EOF]
  96 ?>