application/hub/main/recipient/dht/class_DhtRecipient.php

   1 <?php
   2 /**
   3  * A DHT recipient
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class DhtRecipient extends BaseRecipient implements Recipient {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $recipientInstance              An instance of a Recipient class
  39          */
  40         public final static function createDhtRecipient () {
  41                 // Get new instance
  42                 $recipientInstance = new DhtRecipient();
  43
  44                 // Return the prepared instance
  45                 return $recipientInstance;
  46         }
  47
  48         /**
  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.
  53          *
  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
  57          * @return      void
  58          * @throws      FrameworkException      Could throw different exceptions depending on implementation
  59          */
  60         public function resolveRecipient ($recipient, Listable $listInstance, array $packageData) {
  61                 // Debug message
  62                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-RECIPIENT[' . __METHOD__ . ':' . __LINE__ . ']: recipient=' . $recipient . ' - CALLED!');
  63
  64                 // Make sure the recipient is valid
  65                 assert($recipient == NetworkPackage::NETWORK_TARGET_DHT);
  66
  67                 // Get recipient discovery instance
  68                 $discoverInstance = ObjectFactory::createObjectByConfiguredName('dht_recipient_discovery_class');
  69
  70                 // "Discover" recipients by given package data
  71                 $recipients = $discoverInstance->resolveRecipientsByPackageData($packageData);
  72
  73                 // Now "walk" through all elements and add them to the list
  74                 foreach ($recipients as $recipient) {
  75                         // These array elements must exist for this loop:
  76                         assert(!empty($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP]));
  77                         assert(!empty($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT]));
  78
  79                         // Put ip and port both together
  80                         $ipPort = $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP] . ':' . $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT];
  81
  82                         // Add it to the list
  83                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-RECIPIENT[' . __METHOD__ . ':' . __LINE__ . ']: Calling listInstance->addEntry(' . $ipPort . ') ...');
  84                         $listInstance->addEntry('ip_port', $ipPort);
  85                 } // END - foreach
  86
  87                 // Debug message
  88                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-RECIPIENT[' . __METHOD__ . ':' . __LINE__ . ']: recipient=' . $recipient . ' - EXIT!');
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>