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       $listenerInstance       An instance of a Listenable class
  52          * @return      void
  53          */
  54         public function fillWithListenerInformation (Listenable $listenerInstance) {
  55                 // Debug message
  56                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $listenerInstance->getProtocolName() . ',listenerInstance=' . $listenerInstance->__toString() . ' - CALLED!');
  57
  58                 // Fill the generic array with several data from the listener:
  59                 $this->setProtocolName($listenerInstance->getProtocolName());
  60                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $listenerInstance->getListenAddress());
  61                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT    , $listenerInstance->getListenPort());
  62
  63                 // Set listener here
  64                 $this->setListenerInstance($listenerInstance);
  65
  66                 // Debug message
  67                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
  68         }
  69
  70         /**
  71          * Fills the information class with data from a ConnectionHelper instance
  72          *
  73          * @param       $helperInstance         An instance of a ConnectionHelper class
  74          * @return      void
  75          */
  76         public function fillWithConnectionHelperInformation (ConnectionHelper $helperInstance) {
  77                 // Debug message
  78                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $helperInstance->getProtocolName() . ',helperInstance=' . $helperInstance->__toString() . ',socketResource=' . $helperInstance->getSocketResource() . ' - CALLED!');
  79
  80                 // Fill the generic array with several data from the listener:
  81                 $this->setProtocolName($helperInstance->getProtocolName());
  82                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $helperInstance->getAddress());
  83                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT    , $helperInstance->getConnectionPort());
  84
  85                 // Set helper here
  86                 $this->setHelperInstance($helperInstance);
  87
  88                 // Debug message
  89                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
  90         }
  91
  92         /**
  93          * Getter for address
  94          *
  95          * @return      $address        Address from shared information
  96          */
  97         public final function getAddress () {
  98                 // Return it from generic array
  99                 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
 100         }
 101
 102         /**
 103          * Getter for port
 104          *
 105          * @return      $port   Port from shared information
 106          */
 107         public final function getPort () {
 108                 // Return it from generic array
 109                 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);
 110         }
 111 }
 112
 113 // [EOF]
 114 ?>