3 * A decorator for the TcpListener to communicate to hubs
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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();
69 * Accepts the visitor to process the visit "request"
71 * @param $visitorInstance An instance of a Visitor class
74 public function accept (Visitor $visitorInstance) {
75 // Visit this decorator
76 $visitorInstance->visitDecorator($this);
78 // Visit the covered class
79 $visitorInstance->visitListener($this->getListenerInstance());
83 * Getter for listener type.
85 * @return $listenerType The listener's type (hub/peer)
87 public final function getListenerType () {
88 return $this->listenerType;
92 * Setter for listener type.
94 * @param $listenerType The listener's type (hub/peer)
97 protected final function setListenerType ($listenerType) {
98 $this->listenerType = $listenerType;
102 * Getter for peer pool instance
104 * @return $poolInstance A peer pool instance
106 public final function getPoolInstance () {
107 return $this->getListenerInstance()->getPoolInstance();
111 * Monitors incoming raw data from the handler and transfers it to the
112 * given receiver instance.
114 * @param $receiverInstance An instance of a Receivable class
117 public function monitorIncomingRawData (Receivable $receiverInstance) {
118 // Get the handler instance
119 $handlerInstance = $this->getListenerInstance()->getHandlerInstance();
122 * Does our deocorated listener (or even a decorator again) have a
123 * handler assigned? Remember that a handler will hold all incoming raw
124 * data and not a listener.
126 if (!$handlerInstance instanceof Networkable) {
127 // Skip this silently for now. Later on, this will become mandatory!
128 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('No handler assigned to this listener decorator. this=' . $this->__toString() . ', listenerInstance=' . $this->getListenerInstance()->__toString());
132 // Does the handler have some decoded data pending?
133 if (!$handlerInstance->isRawDataPending()) {
134 // No data is pending so skip further code silently
139 * We have some pending decoded data. The receiver instance is an
140 * abstract network package (which can be received and sent out) so
141 * handle the decoded data over. At this moment we don't need to know
142 * if the decoded data origins from a TCP or UDP connection so we can
143 * just pass it over to the network package receiver
145 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-LISTENER-DECORATOR[' . __METHOD__ . ':' . __LINE__ . '] Going to handle over some raw data to receiver instance (' . $receiverInstance->__toString() . ') ...');
146 $receiverInstance->addRawDataToIncomingStack($handlerInstance);