5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 UpperRecipient extends BaseRecipient implements Recipient {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $recipientInstance An instance of a Recipient class
40 public final static function createUpperRecipient () {
42 $recipientInstance = new UpperRecipient();
44 // Return the prepared instance
45 return $recipientInstance;
49 * Tries to resolve given recipient into session ids or Universal Node Locator
50 * depending on implementation (hint: Template Method Pattern)
52 * @param $recipient Recipient to resolve (e.g. could be a virtual recipient or direct session id)
53 * @param $listInstance An instance of a Listable class
54 * @param $packageData Valid package data array
55 * @return $resolved Resolved recipient or VOID if only the set list has been filled
56 * @throws FrameworkException Could throw different exceptions depending on implementation
58 public function resolveRecipient ($recipient, Listable $listInstance, array $packageData) {
59 // Make sure the recipient is valid
60 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('UPPER-RECIPIENT: recipient=' . $recipient);
61 assert($recipient == NetworkPackage::NETWORK_TARGET_UPPER);
63 // Get all bootstrap nodes
64 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $unlArray) {
65 // Is maximum reached?
66 if ($listInstance->count() == $this->getConfigInstance()->getConfigEntry('package_recipient_max_count')) {
68 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-RESOLVER: Going to abort at maximum of ' . $this->getConfigInstance()->getConfigEntry('package_recipient_max_count') . ' recipients!');
70 // Then stop adding more
75 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-RESOLVER: Adding node ' . print_r($unlArray, TRUE) . ' as recipient.');
78 $listInstance->addEntry('unl', $unlArray);