3 namespace CoreFramework\Information\Connection;
5 // Import framework stuff
6 use CoreFramework\Listener\Listenable;
7 use CoreFramework\Registry\Registerable;
10 * A Connection information class
12 * @author Roland Haeder <webmaster@ship-simu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.ship-simu.org
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.
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.
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/>.
31 class ConnectionInfo extends BaseInfo implements ShareableInfo, Registerable {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this class
45 * @return $infoInstance An instance of a ShareableInfo class
47 public final static function createConnectionInfo () {
49 $infoInstance = new ConnectionInfo();
51 // Return the prepared instance
56 * Fills the information class with data from a Listenable instance
58 * @param $listenerInstance An instance of a Listenable class
61 public function fillWithListenerInformation (Listenable $listenerInstance) {
63 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $listenerInstance->getProtocolName() . ',listenerInstance=' . $listenerInstance->__toString() . ' - CALLED!');
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());
71 $this->setListenerInstance($listenerInstance);
74 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
78 * Fills the information class with data from a ConnectionHelper instance
80 * @param $helperInstance An instance of a ConnectionHelper class
83 public function fillWithConnectionHelperInformation (ConnectionHelper $helperInstance) {
85 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $helperInstance->getProtocolName() . ',helperInstance=' . $helperInstance->__toString() . ',socketResource=' . $helperInstance->getSocketResource() . ' - CALLED!');
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());
93 $this->setHelperInstance($helperInstance);
96 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
102 * @return $address Address from shared information
104 public final function getAddress () {
105 // Return it from generic array
106 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
112 * @return $port Port from shared information
114 public final function getPort () {
115 // Return it from generic array
116 return $this->getGenericArrayElement('connection', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);