3 namespace CoreFramework\Information\Connection;
5 // Import framework stuff
6 use CoreFramework\Information\ShareableInfo;
7 use CoreFramework\Listener\Listenable;
8 use CoreFramework\Registry\Registerable;
11 * A Connection information class
13 * @author Roland Haeder <webmaster@ship-simu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.ship-simu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class ConnectionInfo extends BaseInfo implements ShareableInfo, Registerable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this class
46 * @return $infoInstance An instance of a ShareableInfo class
48 public final static function createConnectionInfo () {
50 $infoInstance = new ConnectionInfo();
52 // Return the prepared instance
57 * Fills the information class with data from a Listenable instance
59 * @param $listenerInstance An instance of a Listenable class
62 public function fillWithListenerInformation (Listenable $listenerInstance) {
64 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $listenerInstance->getProtocolName() . ',listenerInstance=' . $listenerInstance->__toString() . ' - CALLED!');
66 // Fill the generic array with several data from the listener:
67 $this->setProtocolName($listenerInstance->getProtocolName());
68 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $listenerInstance->getListenAddress());
69 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT , $listenerInstance->getListenPort());
72 $this->setListenerInstance($listenerInstance);
75 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
79 * Fills the information class with data from a ConnectionHelper instance
81 * @param $helperInstance An instance of a ConnectionHelper class
84 public function fillWithConnectionHelperInformation (ConnectionHelper $helperInstance) {
86 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $helperInstance->getProtocolName() . ',helperInstance=' . $helperInstance->__toString() . ',socketResource=' . $helperInstance->getSocketResource() . ' - CALLED!');
88 // Fill the generic array with several data from the listener:
89 $this->setProtocolName($helperInstance->getProtocolName());
90 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS , $helperInstance->getAddress());
91 $this->setGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT , $helperInstance->getConnectionPort());
94 $this->setHelperInstance($helperInstance);
97 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
103 * @return $address Address from shared information
105 public final function getAddress () {
106 // Return it from generic array
107 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
113 * @return $port Port from shared information
115 public final function getPort () {
116 // Return it from generic array
117 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);