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@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 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 BaseListenerDecorator extends BaseHubSystem implements Visitable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Getter for listen address
  38          *
  39          * @return      $listenAddress  The address this listener should listen on
  40          */
  41         public final function getListenAddress () {
  42                 return $this->getListenerInstance()->getListenAddress();
  43         }
  44
  45         /**
  46          * Getter for listen port
  47          *
  48          * @return      $listenPort             The port this listener should listen on
  49          */
  50         public final function getListenPort () {
  51                 return $this->getListenerInstance()->getListenPort();
  52         }
  53
  54         /**
  55          * Getter for protocol
  56          *
  57          * @return      $protocol       The used protocol
  58          */
  59         public final function getProtocol () {
  60                 return $this->getListenerInstance()->getProtocol();
  61         }
  62
  63         /**
  64          * Accepts the visitor to rpocess the visit "request"
  65          *
  66          * @param       $visitorInstance        An instance of a Visitor class
  67          * @return      void
  68          */
  69         public function accept (Visitor $visitorInstance) {
  70                 // Debug message
  71                 //* DEBUG: */ $this->debugOutput('DECO-LISTENER: ' . $visitorInstance->__toString() . ' has visited - START');
  72
  73                 // Visit this decorator
  74                 $visitorInstance->visitDecorator($this);
  75
  76                 // Visit the covered class
  77                 $visitorInstance->visitListener($this);
  78
  79                 // Debug message
  80                 //* DEBUG: */ $this->debugOutput('DECO-LISTENER: ' . $visitorInstance->__toString() . ' has visited - FINISHED');
  81         }
  82 }
  83
  84 // [EOF]
  85 ?>