3 * A default listener pool
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
24 class DefaultListenerPool extends BasePool implements PoolableListener {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $nodeInstance A NodeHelper instance
39 * @return $listenerInstance An instance a prepared listener class
41 public static final function createDefaultListenerPool (NodeHelper $nodeInstance) {
43 $listenerInstance = new DefaultListenerPool();
46 self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ':] Setting node ...');
48 // Set the application instance
49 $listenerInstance->setNodeInstance($nodeInstance);
51 // Return the prepared instance
52 return $listenerInstance;
56 * Adds a listener instance to this pool
58 * @param $listenerInstance An instance of a Listenable class
61 public function addListener (Listenable $listenerInstance) {
62 // Add this listener instance to the instance list
63 parent::addInstance($listenerInstance->getProtocolName(), 'listener', $listenerInstance);
66 self::createDebugInstance(__CLASS__)->debugOutput(
67 'POOL[' . __METHOD__ . ':' . __LINE__ . ']: Listener ' . $listenerInstance->__toString() .
68 ' listening to ' . $listenerInstance->getListenAddress() . ':' .
69 $listenerInstance->getListenPort() . ' added to listener pool.'
74 * Run the shutdown seqeuence by a Visitor Pattern
78 public function doShutdown () {
80 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down listener pool - CALLED!');
83 $visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_listener_pool_visitor_class');
86 $this->accept($visitorInstance);
89 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down listener pool - EXIT!');