application/hub/main/discovery/class_BaseNodeDiscovery.php

   1 <?php
   2 /**
   3  * A PackageRecipient discovery class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 BaseNodeDiscovery extends BaseDiscovery implements Discoverable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Real class name
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34
  35                 /*
  36                  * Get recipients list instance and set it here for all discovery
  37                  * implementations.
  38                  */
  39                 $listInstance = RecipientListFactory::createRecipientListInstance();
  40                 $this->setListInstance($listInstance);
  41         }
  42
  43         /**
  44          * Determines the protoctol name
  45          *
  46          * @param       $packageData    Valid package data
  47          * @return      $protocolName   Name of used protocol (TCP/UDP/etc.)
  48          */
  49         protected function determineProtocolByPackageData (array $packageData) {
  50                 // First we need a tags instance
  51                 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
  52
  53                 /*
  54                  * We need to decide here which socket (TCP or UDP) should be used for
  55                  * the actual data transmission. In this process we will find out if
  56                  * the recipient of this package has already a known (registered) socket
  57                  * and if so we can re-use it. If there is no socket registered, we try
  58                  * to make a new connection (TCP or UDP) to the given IP:port.
  59                  */
  60                 $protocolName = $tagsInstance->chooseProtocolFromPackageData($packageData);
  61
  62                 // Return it
  63                 return $protocolName;
  64         }
  65
  66         /**
  67          * "Getter" for recipient iterator
  68          *
  69          * @return$iteratorInstance An instance of a Iterateable object
  70          */
  71         public final function getIterator () {
  72                 // Get iterator from it
  73                 $iteratorInstance = $this->getListInstance()->getIterator();
  74
  75                 // Return it
  76                 return $iteratorInstance;
  77         }
  78
  79         /**
  80          * Clears all recipients for e.g. another package to deliver. This method
  81          * simply clears the inner list instance.
  82          *
  83          * @return      void
  84          */
  85         public final function clearRecipients () {
  86                 // Clear the list
  87                 $this->getListInstance()->clearList();
  88         }
  89
  90         /**
  91          * Checks whether the recipient list is empty
  92          *
  93          * @return      $isEmpty        Whether the recipient list is empty
  94          */
  95         public final function isRecipientListEmpty () {
  96                 // Check it ...
  97                 $isEmpty = ($this->getListInstance()->count() == 0);
  98
  99                 // Return it
 100                 return $isEmpty;
 101         }
 102 }
 103
 104 // [EOF]
 105 ?>