application/hub/main/info/connection/class_ConnectionInfo.php

   1 <?php
   2 /**
   3  * A Connection information class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 ConnectionInfo extends BaseInfo implements ShareableInfo, Registerable {
  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      $infoInstance   An instance of a ShareableInfo class
  39          */
  40         public final static function createConnectionInfo () {
  41                 // Get new instance
  42                 $infoInstance = new ConnectionInfo();
  43
  44                 // Return the prepared instance
  45                 return $infoInstance;
  46         }
  47
  48         /**
  49          * Fills the information class with data from a Listenable instance
  50          *
  51          * @param       $listenerInstanc        An instance of a Listenable class
  52          * @return      void
  53          */
  54         public function fillWithListenerInformation (Listenable $listenerInstance) {
  55                 // Fill the generic array with several data from the listener:
  56                 $this->setProtocolName($listenerInstance->getProtocolName());
  57                 $this->setGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $listenerInstance->getListenAddress());
  58                 $this->setGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT    , $listenerInstance->getListenPort());
  59
  60                 // Set listener here
  61                 $this->setListenerInstance($listenerInstance);
  62         }
  63
  64         /**
  65          * Getter for address
  66          *
  67          * @return      $address        Address from shared information
  68          */
  69         public final function getAddress () {
  70                 // Return it from generic array
  71                 return $this->getGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
  72         }
  73
  74         /**
  75          * Getter for port
  76          *
  77          * @return      $port   Port from shared information
  78          */
  79         public final function getPort () {
  80                 // Return it from generic array
  81                 return $this->getGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>