framework/main/classes/info/connection/class_ConnectionInfo.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Information\Connection;
   4
   5 // Import framework stuff
   6 use CoreFramework\Listener\Listenable;
   7 use CoreFramework\Registry\Registerable;
   8
   9 /**
  10  * A Connection information class
  11  *
  12  * @author              Roland Haeder <webmaster@ship-simu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.ship-simu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class ConnectionInfo extends BaseInfo implements ShareableInfo, Registerable {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this class
  44          *
  45          * @return      $infoInstance   An instance of a ShareableInfo class
  46          */
  47         public final static function createConnectionInfo () {
  48                 // Get new instance
  49                 $infoInstance = new ConnectionInfo();
  50
  51                 // Return the prepared instance
  52                 return $infoInstance;
  53         }
  54
  55         /**
  56          * Fills the information class with data from a Listenable instance
  57          *
  58          * @param       $listenerInstance       An instance of a Listenable class
  59          * @return      void
  60          */
  61         public function fillWithListenerInformation (Listenable $listenerInstance) {
  62                 // Debug message
  63                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $listenerInstance->getProtocolName() . ',listenerInstance=' . $listenerInstance->__toString() . ' - CALLED!');
  64
  65                 // Fill the generic array with several data from the listener:
  66                 $this->setProtocolName($listenerInstance->getProtocolName());
  67                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $listenerInstance->getListenAddress());
  68                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT    , $listenerInstance->getListenPort());
  69
  70                 // Set listener here
  71                 $this->setListenerInstance($listenerInstance);
  72
  73                 // Debug message
  74                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
  75         }
  76
  77         /**
  78          * Fills the information class with data from a ConnectionHelper instance
  79          *
  80          * @param       $helperInstance         An instance of a ConnectionHelper class
  81          * @return      void
  82          */
  83         public function fillWithConnectionHelperInformation (ConnectionHelper $helperInstance) {
  84                 // Debug message
  85                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $helperInstance->getProtocolName() . ',helperInstance=' . $helperInstance->__toString() . ',socketResource=' . $helperInstance->getSocketResource() . ' - CALLED!');
  86
  87                 // Fill the generic array with several data from the listener:
  88                 $this->setProtocolName($helperInstance->getProtocolName());
  89                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $helperInstance->getAddress());
  90                 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT    , $helperInstance->getConnectionPort());
  91
  92                 // Set helper here
  93                 $this->setHelperInstance($helperInstance);
  94
  95                 // Debug message
  96                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
  97         }
  98
  99         /**
 100          * Getter for address
 101          *
 102          * @return      $address        Address from shared information
 103          */
 104         public final function getAddress () {
 105                 // Return it from generic array
 106                 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
 107         }
 108
 109         /**
 110          * Getter for port
 111          *
 112          * @return      $port   Port from shared information
 113          */
 114         public final function getPort () {
 115                 // Return it from generic array
 116                 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);
 117         }
 118
 119 }