application/hub/main/listener/class_BaseListenerDecorator.php

   1 <?php
   2 /**
   3  * A general decorator for listeners 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 - 2014 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          * Accepts the visitor to process the visit "request"
  61          *
  62          * @param       $visitorInstance        An instance of a Visitor class
  63          * @return      void
  64          */
  65         public function accept (Visitor $visitorInstance) {
  66                 // Visit this decorator
  67                 $visitorInstance->visitDecorator($this);
  68
  69                 // Visit the covered class
  70                 $visitorInstance->visitListener($this->getListenerInstance());
  71         }
  72
  73         /**
  74          * Getter for listener type.
  75          *
  76          * @return      $listenerType   The listener's type (hub/peer)
  77          */
  78         public final function getListenerType () {
  79                 return $this->listenerType;
  80         }
  81
  82         /**
  83          * Setter for listener type.
  84          *
  85          * @param       $listenerType   The listener's type (hub/peer)
  86          * @return      void
  87          */
  88         protected final function setListenerType ($listenerType) {
  89                 $this->listenerType = $listenerType;
  90         }
  91
  92         /**
  93          * Getter for peer pool instance
  94          *
  95          * @return      $poolInstance   A peer pool instance
  96          */
  97         public final function getPoolInstance () {
  98                 return $this->getListenerInstance()->getPoolInstance();
  99         }
 100
 101         /**
 102          * Monitors incoming raw data from the handler and transfers it to the
 103          * given receiver instance.
 104          *
 105          * @param       $receiverInstance       An instance of a Receivable class
 106          * @return      void
 107          */
 108         public function monitorIncomingRawData (Receivable $receiverInstance) {
 109                 // Get the handler instance
 110                 $handlerInstance = $this->getListenerInstance()->getHandlerInstance();
 111
 112                 /*
 113                  * Does our deocorated listener (or even a decorator again) have a
 114                  * handler assigned? Remember that a handler will hold all incoming raw
 115                  * data and not a listener.
 116                  */
 117                 if (!$handlerInstance instanceof Networkable) {
 118                         // Skip this silently for now. Later on, this will become mandatory!
 119                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('No handler assigned to this listener decorator. this=' . $this->__toString() . ', listenerInstance=' . $this->getListenerInstance()->__toString());
 120                         return;
 121                 } // END - if
 122
 123                 // Does the handler have some decoded data pending?
 124                 if (!$handlerInstance->isRawDataPending()) {
 125                         // No data is pending so skip further code silently
 126                         return;
 127                 } // END - if
 128
 129                 /*
 130                  * We have some pending decoded data. The receiver instance is an
 131                  * abstract network package (which can be received and sent out) so
 132                  * handle the decoded data over. At this moment we don't need to know
 133                  * if the decoded data origins from a TCP or UDP connection so we can
 134                  * just pass it over to the network package receiver
 135                  */
 136                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-LISTENER-DECORATOR[' . __METHOD__ . ':' . __LINE__ . '] Going to handle over some raw data to receiver instance (' . $receiverInstance->__toString() . ') ...');
 137                 $receiverInstance->addRawDataToIncomingStack($handlerInstance);
 138         }
 139 }
 140
 141 // [EOF]
 142 ?>