5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 DhtRecipient 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 createDhtRecipient () {
42 $recipientInstance = new DhtRecipient();
44 // Return the prepared instance
45 return $recipientInstance;
49 * Tries to resolve given recipient into session ids or ip:port combination
50 * depending on implementation (hint: Template Method Pattern). This
51 * implementation will add more than one recipient to the list as a DHT is
52 * distributed and the package might go to more than one recipient.
54 * @param $recipient Recipient to resolve (e.g. could be a virtual recipient or direct session id)
55 * @param $listInstance An instance of a Listable class
56 * @param $packageData Valid package data array
58 * @throws FrameworkException Could throw different exceptions depending on implementation
60 public function resolveRecipient ($recipient, Listable $listInstance, array $packageData) {
61 // Make sure the recipient is valid
62 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-RECIPIENT: recipient=' . $recipient);
63 assert($recipient == NetworkPackage::NETWORK_TARGET_DHT);
65 // Get recipient discovery instance
66 $discoverInstance = ObjectFactory::createObjectByConfiguredName('dht_recipient_discovery_class');
68 // "Discover" recipients by given package data
69 $recipients = $discoverInstance->resolveRecipientsByPackageData($packageData);
71 // Now "walk" through all elements and add them to the list
72 foreach ($recipients as $recipient) {
73 // These array elements must exist for this loop:
74 assert(isset($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP]));
75 assert(isset($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT]));
77 // Put ip and port both together
78 $ipPort = $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP] . ':' . $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT];
81 $listInstance->addEntry('ip_port', $ipPort);