application/hub/main/recipient/upper/class_UpperRecipient.php

   1 <?php
   2 /**
   3  * A Upper recipient
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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.ship-simu.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 UpperRecipient 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 createUpperRecipient () {
  41                 // Get new instance
  42                 $recipientInstance = new UpperRecipient();
  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)
  51          *
  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          * @return      $resolved               Resolved recipient or VOID if only the set list has been filled
  55          * @throws      FrameworkException      Could throw different exceptions depending on implementation
  56          */
  57         public function resolveRecipient ($recipient, Listable $listInstance) {
  58                 // Make sure the recipient is valid
  59                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('UPPER-RECIPIENT: recipient=' . $recipient);
  60                 assert($recipient == NetworkPackage::PACKAGE_RECIPIENT_UPPER);
  61
  62                 // Get all bootstrap nodes
  63                 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
  64                         // Is maximum reached?
  65                         if ($listInstance->count() == $this->getConfigInstance()->getConfigEntry('package_recipient_max_count')) {
  66                                 // Debug message
  67                                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-RESOLVER: Going to abort at maximum of ' . $this->getConfigInstance()->getConfigEntry('package_recipient_max_count') . ' recipients!');
  68
  69                                 // Then stop adding more
  70                                 break;
  71                         } // END - if
  72
  73                         // Debug message
  74                         /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-RESOLVER: Adding node ' . $ipPort . ' as recipient.');
  75
  76                         // Add the entry
  77                         $listInstance->addEntry('ip_port', $ipPort);
  78                 } // END - foreach
  79         }
  80 }
  81
  82 // [EOF]
  83 ?>