3 * A decorator for the TcpListener to communicate to hubs
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 BaseListenerDecorator extends BaseDecorator implements Visitable {
28 private $listenerType = 'invalid';
31 * Protected constructor
33 * @param $className Name of the class
36 protected function __construct ($className) {
37 // Call parent constructor
38 parent::__construct($className);
42 * Getter for listen address
44 * @return $listenAddress The address this listener should listen on
46 public final function getListenAddress () {
47 return $this->getListenerInstance()->getListenAddress();
51 * Getter for listen port
53 * @return $listenPort The port this listener should listen on
55 public final function getListenPort () {
56 return $this->getListenerInstance()->getListenPort();
62 * @return $port The port
64 public final function getPort () {
65 return $this->getListenerInstance()->getPort();
71 * @return $protocol The used protocol
73 public final function getProtocol () {
74 return $this->getListenerInstance()->getProtocol();
78 * Accepts the visitor to process the visit "request"
80 * @param $visitorInstance An instance of a Visitor class
83 public function accept (Visitor $visitorInstance) {
84 // Visit this decorator
85 $visitorInstance->visitDecorator($this);
87 // Visit the covered class
88 $visitorInstance->visitListener($this->getListenerInstance());
92 * Getter for listener type.
94 * @return $listenerType The listener's type (hub/peer)
96 public final function getListenerType () {
97 return $this->listenerType;
101 * Setter for listener type.
103 * @param $listenerType The listener's type (hub/peer)
106 protected final function setListenerType ($listenerType) {
107 $this->listenerType = $listenerType;
111 * Getter for peer pool instance
113 * @return $poolInstance The peer pool instance we shall set
115 public final function getPoolInstance () {
116 return $this->getListenerInstance()->getPoolInstance();