application/hub/main/listener/class_BaseListenerDecorator.php

   1 <?php
   2 /**
   3  * A decorator for the TcpListener to communicate to hubs
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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 BaseListenerDecorator extends BaseDecorator implements Visitable {
  25         /**
  26          * Listener type
  27          */
  28         private $listenerType = 'invalid';
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Getter for listen address
  43          *
  44          * @return      $listenAddress  The address this listener should listen on
  45          */
  46         public final function getListenAddress () {
  47                 return $this->getListenerInstance()->getListenAddress();
  48         }
  49
  50         /**
  51          * Getter for listen port
  52          *
  53          * @return      $listenPort             The port this listener should listen on
  54          */
  55         public final function getListenPort () {
  56                 return $this->getListenerInstance()->getListenPort();
  57         }
  58
  59         /**
  60          * Getter for port
  61          *
  62          * @return      $port   The port
  63          */
  64         public final function getPort () {
  65                 return $this->getListenerInstance()->getPort();
  66         }
  67
  68         /**
  69          * Getter for protocol
  70          *
  71          * @return      $protocol       The used protocol
  72          */
  73         public final function getProtocol () {
  74                 return $this->getListenerInstance()->getProtocol();
  75         }
  76
  77         /**
  78          * Accepts the visitor to process the visit "request"
  79          *
  80          * @param       $visitorInstance        An instance of a Visitor class
  81          * @return      void
  82          */
  83         public function accept (Visitor $visitorInstance) {
  84                 // Visit this decorator
  85                 $visitorInstance->visitDecorator($this);
  86
  87                 // Visit the covered class
  88                 $visitorInstance->visitListener($this->getListenerInstance());
  89         }
  90
  91         /**
  92          * Getter for listener type.
  93          *
  94          * @return      $listenerType   The listener's type (hub/peer)
  95          */
  96         public final function getListenerType () {
  97                 return $this->listenerType;
  98         }
  99
 100         /**
 101          * Setter for listener type.
 102          *
 103          * @param       $listenerType   The listener's type (hub/peer)
 104          * @return      void
 105          */
 106         protected final function setListenerType ($listenerType) {
 107                 $this->listenerType = $listenerType;
 108         }
 109
 110         /**
 111          * Getter for peer pool instance
 112          *
 113          * @return      $poolInstance   A peer pool instance
 114          */
 115         public final function getPoolInstance () {
 116                 return $this->getListenerInstance()->getPoolInstance();
 117         }
 118
 119         /**
 120          * Monitors incoming raw data from the handler and transfers it to the
 121          * given receiver instance.
 122          *
 123          * @param       $receiverInstance       An instance of a Receivable class
 124          * @return      void
 125          */
 126         public function monitorIncomingRawData (Receivable $receiverInstance) {
 127                 // Get the handler instance
 128                 $handlerInstance = $this->getListenerInstance()->getHandlerInstance();
 129
 130                 /*
 131                  * Does our deocorated listener (or even a decorator again) have a
 132                  * handler assigned? Remember that a handler will hold all incoming raw
 133                  * data and not a listener.
 134                  */
 135                 if (!$handlerInstance instanceof Networkable) {
 136                         // Skip this silently for now. Later on, this will become mandatory!
 137                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('No handler assigned to this listener decorator. this=' . $this->__toString() . ', listenerInstance=' . $this->getListenerInstance()->__toString());
 138                         return;
 139                 } // END - if
 140
 141                 // Does the handler have some decoded data pending?
 142                 if (!$handlerInstance->isRawDataPending()) {
 143                         // No data is pending so skip further code silently
 144                         return;
 145                 } // END - if
 146
 147                 /*
 148                  * We have some pending decoded data. The receiver instance is an
 149                  * abstract network package (which can be received and sent out) so
 150                  * handle the decoded data over. At this moment we don't need to know
 151                  * if the decoded data origins from a TCP or UDP connection so we can
 152                  * just pass it over to the network package receiver
 153                  */
 154                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-LISTENER-DECORATOR[' . __METHOD__ . ':' . __LINE__ . '] Going to handle over some raw data to receiver instance (' . $receiverInstance->__toString() . ') ...');
 155                 $receiverInstance->addRawDataToIncomingStack($handlerInstance);
 156         }
 157 }
 158
 159 // [EOF]
 160 ?>