3 * A UniversalNodeLocator discovery class
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 UniversalNodeLocatorDiscovery extends BaseNodeDiscovery implements DiscoverableUniversalNodeLocator, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Create an instance of this class
38 * @return $discoveryInstance An instance of this discovery class
40 public static final function createUniversalNodeLocatorDiscovery () {
41 // Get an instance of this class
42 $discoveryInstance = new UniversalNodeLocatorDiscovery();
44 // Return the prepared instance
45 return $discoveryInstance;
49 * "Discovers" an instance of a LocateableNode class for given NodeHelper class
51 * @param $nodeInstance An instance of a NodeHelper class
52 * @return $unlInstance An instance of a LocateableNode class
54 public function discoverUniversalNodeLocatorByNode (NodeHelper $nodeInstance) {
56 * First get an instance from the configured hub communication protocol
57 * type (which is mostly TCP, so you get a TcpProtocolResolver here).
59 $resolverInstance = ProtocolResolverFactory::createResolverFromConfiguredProtocol();
61 // Then resolve the node instance into an UNL instance
62 $unlInstance = $resolverInstance->resolveUniversalNodeLocatorFromNodeHelper($nodeInstance);
69 * "Discovers" the full universal node locator for given configuration entry
70 * which should represent the address part of the UNL. In case of an IP
71 * address, this *must not* include the port number as this is being found
74 * Valid values for $configKey: internal,external
76 * @param $configKey Key for address to get (valid: internal,external)
77 * @return $unl Universal node locator
79 public function discoverUniversalNodeLocatorByConfiguredAddress ($configKey) {
81 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('UNL-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']:configKey=' . $configKey . ' - CALLED!');
84 if (!isset($GLOBALS[__METHOD__][$configKey])) {
85 // Validate config key
86 assert(($configKey == 'internal') || ($configKey == 'external'));
89 * First get an instance from the configured hub communication protocol
90 * type (which is mostly TCP, so you get a TcpProtocolResolver here).
92 $resolverInstance = ProtocolResolverFactory::createResolverFromConfiguredProtocol();
94 // Get back the full UNL
95 $GLOBALS[__METHOD__][$configKey] = $resolverInstance->resolveUniversalNodeLocatorFromConfigKey($configKey);
98 // Return cached value
99 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('UNL-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']:configKey=' . $configKey . ',unl=' . $GLOBALS[__METHOD__][$configKey] . ' - EXIT!');
100 return $GLOBALS[__METHOD__][$configKey];