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

   1 <?php
   2 /**
   3  * A default listener pool
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 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                 // Return the prepared instance
  46                 return $listenerInstance;
  47         }
  48
  49         /**
  50          * Adds a listener instance to this pool
  51          *
  52          * @param       $listenerInstance       An instance of a Listenable class
  53          * @return      void
  54          */
  55         public function addListener (Listenable $listenerInstance) {
  56                 // Add this listener instance to the instance list
  57                 parent::addInstance($listenerInstance->getProtocolName(), 'listener', $listenerInstance);
  58
  59                 // Debug message
  60                 self::createDebugInstance(__CLASS__)->debugOutput(
  61                         'POOL[' . __METHOD__ . ':' . __LINE__ . ']: Listener ' . $listenerInstance->__toString() .
  62                         ' listening to ' . $listenerInstance->getListenAddress() . ':' .
  63                         $listenerInstance->getListenPort() . ' added to listener pool.'
  64                 );
  65         }
  66
  67         /**
  68          * Run the shutdown seqeuence by a Visitor Pattern
  69          *
  70          * @return      void
  71          */
  72         public function doShutdown () {
  73                 // Debug message
  74                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down listener pool - CALLED!');
  75
  76                 // Get a new visitor
  77                 $visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_listener_pool_visitor_class');
  78
  79                 // Start visiting
  80                 $this->accept($visitorInstance);
  81
  82                 // Debug message
  83                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down listener pool - EXIT!');
  84         }
  85 }
  86
  87 // [EOF]
  88 ?>