3 * A general listener class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 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 BaseListener extends BaseHubSystem implements Visitable {
25 // Exception code constants
26 const EXCEPTION_INVALID_SOCKET = 0xa00;
29 * Used protocol (Default: invalid, which is indeed invalid...)
31 private $protcol = 'invalid';
34 * Address (IP mostly) we shall listen on
36 private $listenAddress = '0.0.0.0'; // This is the default and listens on all interfaces
39 * Port we shall listen on (or wait for incoming data)
41 private $listenPort = 0; // This port MUST be changed by your application
44 * Wether we are in blocking or non-blocking mode (default: non-blocking
46 private $blockingMode = false;
51 private $socketResource = false;
54 * A client pool instance
56 private $poolInstance = null;
59 * Protected constructor
61 * @param $className Name of the class
64 protected function __construct ($className) {
65 // Call parent constructor
66 parent::__construct($className);
70 * Setter for listen address
72 * @param $listenAddress The address this listener should listen on
75 protected final function setListenAddress ($listenAddress) {
76 $this->listenAddress = (string) $listenAddress;
80 * Getter for listen address
82 * @return $listenAddress The address this listener should listen on
84 public final function getListenAddress () {
85 return $this->listenAddress;
89 * Setter for listen port
91 * @param $listenPort The port this listener should listen on
94 protected final function setListenPort ($listenPort) {
95 $this->listenPort = (int) $listenPort;
99 * Getter for listen port
101 * @return $listenPort The port this listener should listen on
103 public final function getListenPort () {
104 return $this->listenPort;
108 * "Setter" to set listen address from configuration entry
110 * @param $configEntry The configuration entry holding our listen address
113 public final function setListenAddressByConfiguration ($configEntry) {
114 $this->setListenAddress($this->getConfigInstance()->getConfigEntry($configEntry));
118 * "Setter" to set listen port from configuration entry
120 * @param $configEntry The configuration entry holding our listen port
123 public final function setListenPortByConfiguration ($configEntry) {
124 $this->setListenPort($this->getConfigInstance()->getConfigEntry($configEntry));
128 * Setter for protocol
130 * @param $protocol Used protocol
133 protected final function setProtocol ($protocol) {
134 $this->protocol = (string) $protocol;
138 * Getter for protocol
140 * @return $protocol Used protocol
142 public final function getProtocol () {
143 return $this->protocol;
147 * Setter for blocking-mode
149 * @param $blockingMode Wether blocking-mode is disabled (default) or enabled
152 protected final function setBlockingMode ($blockingMode) {
153 $this->blockingMode = (boolean) $blockingMode;
157 * Checks wether blocking-mode is enabled or disabled
159 * @return $blockingMode Wether blocking mode is disabled or enabled
161 public final function isBlockingModeEnabled () {
162 return $this->blockingMode;
166 * Setter for socket resource
168 * @param $socketResource The socket resource we shall set
171 protected final function setSocketResource ($socketResource) {
172 $this->socketResource = $setSocketResource;
176 * Getter for socket resource
178 * @return $socketResource The socket resource we shall set
180 protected final function getSocketResource () {
181 return $this->socketResource;
185 * Setter for client pool instance
187 * @param $poolInstance The client pool instance we shall set
190 protected final function setPoolInstance (PoolableClient $poolInstance) {
191 $this->poolInstance = $setPoolInstance;
195 * Getter for client pool instance
197 * @return $poolInstance The client pool instance we shall set
199 protected final function getPoolInstance () {
200 return $this->poolInstance;
204 * Accepts the visitor to rpocess the visit "request"
206 * @param $visitorInstance An instance of a Visitor class
209 public function accept (Visitor $visitorInstance) {
211 $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited - START');
213 // Visit this listener
214 $visitorInstance->visitListener($this);
217 $this->getPoolInstance()->accept($visitor);
220 $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited - FINISHED');