application/hub/interfaces/discovery/unl/class_DiscoverableUniversalNodeLocator.php

   1 <?php
   2 /**
   3  * An interface for UNL discovery
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 interface DiscoverableUniversalNodeLocator extends Discoverable {
  25         /**
  26          * "Discovers" an instance of a LocateableNode class for given NodeHelper class
  27          *
  28          * @param       $nodeInstance   An instance of a NodeHelper class
  29          * @return      $unlInstance    An instance of a LocateableNode class
  30          */
  31         function discoverUniversalNodeLocatorByNode (NodeHelper $nodeInstance);
  32
  33         /**
  34          * "Discovers" the full universal node locator for given configuration entry
  35          * which should represent the address part of the UNL. In case of an IP
  36          * address, this *must not* include the port number as this is being found
  37          * out for you.
  38          *
  39          * Valid values for $configKey: internal,external
  40          *
  41          * @param       $configKey      Key for address to get (valid: internal,external)
  42          * @return      $unl            Universal node locator
  43          */
  44         function discoverUniversalNodeLocatorByConfiguredAddress ($configKey);
  45 }
  46
  47 // [EOF]
  48 ?>