3 * A PackageRecipient discovery class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 PackageRecipientDiscovery extends BaseHubDiscovery implements DiscoverableRecipient, 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 createPackageRecipientDiscovery () {
41 // Get an instance of this class
42 $discoveryInstance = new PackageRecipientDiscovery();
44 // Output debug message
45 $discoveryInstance->debugOutput('RECIPIENT-DISCOVERY: Initialized.');
47 // Return the prepared instance
48 return $discoveryInstance;
52 * Tries to discover all recipients for given package data
54 * @param $packageData Raw package data array
57 public function discoverRecipients (array $packageData) {
58 // Get recipients list instance
59 $listInstance = RecipientListFactory::createRecipientListInstance();
61 // We do some rudimentary checks but this might be a bit ugly
62 switch ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]) {
63 // All upper hubs, these are currently the bootstrap nodes and later on prepended list-nodes
64 case NetworkPackage::NETWORK_TARGET_UPPER_HUBS:
65 // Get all bootstrap nodes
66 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPERATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $node) {
68 $listInstance->addEntry('ip_port', $node);
72 // The target 'self' is always the external IP address!
73 case NetworkPackage::NETWORK_TARGET_SELF:
74 // Determine IP or 'external_ip' if set
75 $ip = HubTools::determineOwnExternalIp();
77 // Get port and add it
78 $ipPort = $ip . ':' . $this->getConfigInstance()->getConfigEntry('node_' . $this->determineProtocolByPackageData($packageData) . '_listen_port');
81 $listInstance->addEntry('ip_port', $ipPort);
84 // This may be a direct recipient (node's session id)
86 $this->partialStub('Please add code handling recipients ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
92 * "Getter" for recipient iterator
94 * @return $iteratorInstance An instance of a Iterateable object
96 public function getIterator () {
98 $listInstance = RecipientListFactory::createRecipientListInstance();
100 // Get iterator from it
101 $iteratorInstance = $listInstance->getIterator();
104 return $iteratorInstance;