application/hub/main/visitor/pool/handler/class_HandlerListenerPoolVisitor.php

   1 <?php
   2 /**
   3  * A ListenerPool handler visitor
   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 HandlerListenerPoolVisitor extends BaseVisitor implements ListenerPoolVisitor {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set visitor mode
  35                 $this->setVisitorMode('handler');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $visitorInstance                An instance a Visitorable class
  42          */
  43         public final static function createHandlerListenerPoolVisitor () {
  44                 // Get new instance
  45                 $visitorInstance = new HandlerListenerPoolVisitor();
  46
  47                 // Return the prepared instance
  48                 return $visitorInstance;
  49         }
  50
  51         /**
  52          * Visits the given pool instance
  53          *
  54          * @param       $poolInstance   A Poolable instance
  55          * @return      void
  56          * @todo        Find some use of doListen() method in listener pool classes
  57          */
  58         public function visitPool (Poolable $poolInstance) {
  59                 // The pool itself wont listen to any connections but maybe we need
  60                 // this stub for something later on
  61                 // $poolInstance->doListen();
  62         }
  63
  64         /**
  65          * Visits the given decorator instance
  66          *
  67          * @param       $listenerInstance       A Listenable instance
  68          * @return      void
  69          * @todo        Find some use of doListen() method in listener decorator classes
  70          */
  71         public function visitDecorator (Listenable $listenerInstance) {
  72                 // The decorator itself wont listen to any connections but maybe we need
  73                 // this stub for something later on
  74                 // $listenerInstance->doListen();
  75         }
  76
  77         /**
  78          * Visits the given listener instance
  79          *
  80          * @param       $listenerInstance       A listenerable instance
  81          * @return      void
  82          */
  83         public function visitListener (Listenable $listenerInstance) {
  84                 // Just call the listener->doListen
  85                 $listenerInstance->doListen();
  86         }
  87 }
  88
  89 //
  90 ?>