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