3 * A Connection information class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class ConnectionInfo extends BaseInfo implements ShareableInfo, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $infoInstance An instance of a ShareableInfo class
40 public final static function createConnectionInfo () {
42 $infoInstance = new ConnectionInfo();
44 // Return the prepared instance
49 * Fills the information class with data from a Listenable instance
51 * @param $listenerInstanc An instance of a Listenable class
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());
61 $this->setListenerInstance($listenerInstance);
67 * @return $address Address from shared information
69 public final function getAddress () {
70 // Return it from generic array
71 return $this->getGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_ADDRESS);
77 * @return $port Port from shared information
79 public final function getPort () {
80 // Return it from generic array
81 return $this->getGenericArrayElement('listen', 'dummy', 'dummy', UniversalNodeLocator::UNL_PART_PORT);