application/hub/main/pools/listener/class_DefaultListenerPool.php

   1 <?php
   2 /**
   3  * A default listener pool
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.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.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 DefaultListenerPool extends BasePool implements PoolableListener {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @param       $nodeInstance           A NodeHelper instance
  39          * @return      $listenerInstance       An instance a prepared listener class
  40          */
  41         public static final function createDefaultListenerPool (NodeHelper $nodeInstance) {
  42                 // Get new instance
  43                 $listenerInstance = new DefaultListenerPool();
  44
  45                 // Set the application instance
  46                 $listenerInstance->setNodeInstance($nodeInstance);
  47
  48                 // Return the prepared instance
  49                 return $listenerInstance;
  50         }
  51
  52         /**
  53          * Adds a listener instance to this pool
  54          *
  55          * @param       $listenerInstance       An instance of a Listenable class
  56          * @return      void
  57          */
  58         public function addListener (Listenable $listenerInstance) {
  59                 // Add this listener instance to the instance list
  60                 parent::addInstance($listenerInstance->getProtocol(), 'listener', $listenerInstance);
  61
  62                 // Debug message
  63                 self::createDebugInstance(__CLASS__)->debugOutput(
  64                         'POOL[' . __LINE__ . ']: Listener ' . $listenerInstance->__toString() .
  65                         ' listening to ' . $listenerInstance->getListenAddress() . ':' .
  66                         $listenerInstance->getListenPort() . ' added to listener pool.'
  67                 );
  68         }
  69
  70         /**
  71          * Run the shutdown seqeuence by a Visitor Pattern
  72          *
  73          * @return      void
  74          */
  75         public function doShutdown () {
  76                 // Debug message
  77                 self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __LINE__ . ']: Shutting down listener pool - START');
  78
  79                 // Get a new visitor
  80                 $visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_listener_pool_visitor_class');
  81
  82                 // Start visiting
  83                 $this->accept($visitorInstance);
  84
  85                 // Debug message
  86                 self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __LINE__ . ']: Shutting down listener pool - FINISHED');
  87         }
  88 }
  89
  90 // [EOF]
  91 ?>