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 * A network package handler instance
61 private $packageInstance = null;
64 * Protected constructor
66 * @param $className Name of the class
69 protected function __construct ($className) {
70 // Call parent constructor
71 parent::__construct($className);
75 * Setter for listen address
77 * @param $listenAddress The address this listener should listen on
80 protected final function setListenAddress ($listenAddress) {
81 $this->listenAddress = (string) $listenAddress;
85 * Getter for listen address
87 * @return $listenAddress The address this listener should listen on
89 public final function getListenAddress () {
90 return $this->listenAddress;
94 * Setter for listen port
96 * @param $listenPort The port this listener should listen on
99 protected final function setListenPort ($listenPort) {
100 $this->listenPort = (int) $listenPort;
104 * Getter for listen port
106 * @return $listenPort The port this listener should listen on
108 public final function getListenPort () {
109 return $this->listenPort;
113 * "Setter" to set listen address from configuration entry
115 * @param $configEntry The configuration entry holding our listen address
118 public final function setListenAddressByConfiguration ($configEntry) {
119 $this->setListenAddress($this->getConfigInstance()->getConfigEntry($configEntry));
123 * "Setter" to set listen port from configuration entry
125 * @param $configEntry The configuration entry holding our listen port
128 public final function setListenPortByConfiguration ($configEntry) {
129 $this->setListenPort($this->getConfigInstance()->getConfigEntry($configEntry));
133 * Setter for protocol
135 * @param $protocol Used protocol
138 protected final function setProtocol ($protocol) {
139 $this->protocol = (string) $protocol;
143 * Getter for protocol
145 * @return $protocol Used protocol
147 public final function getProtocol () {
148 return $this->protocol;
152 * Setter for blocking-mode
154 * @param $blockingMode Wether blocking-mode is disabled (default) or enabled
157 protected final function setBlockingMode ($blockingMode) {
158 $this->blockingMode = (boolean) $blockingMode;
162 * Checks wether blocking-mode is enabled or disabled
164 * @return $blockingMode Wether blocking mode is disabled or enabled
166 public final function isBlockingModeEnabled () {
167 return $this->blockingMode;
171 * Setter for socket resource
173 * @param $socketResource The socket resource we shall set
176 protected final function setSocketResource ($socketResource) {
177 $this->socketResource = $socketResource;
181 * Getter for socket resource
183 * @return $socketResource The socket resource we shall set
185 protected final function getSocketResource () {
186 return $this->socketResource;
190 * Setter for client pool instance
192 * @param $poolInstance The client pool instance we shall set
195 protected final function setPoolInstance (PoolableClient $poolInstance) {
196 $this->poolInstance = $poolInstance;
200 * Getter for client pool instance
202 * @return $poolInstance The client pool instance we shall set
204 protected final function getPoolInstance () {
205 return $this->poolInstance;
209 * Setter for network package handler instance
211 * @param $packageInstance The network package handler instance we shall set
214 protected final function setPackageInstance (Networkable $packageInstance) {
215 $this->packageInstance = $packageInstance;
219 * Getter for network package handler instance
221 * @return $packageInstance The network package handler instance we shall set
223 protected final function getPackageInstance () {
224 return $this->packageInstance;
228 * Accepts the visitor to rpocess the visit "request"
230 * @param $visitorInstance An instance of a Visitor class
233 public function accept (Visitor $visitorInstance) {
235 //* DEBUG: */ $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited - START');
237 // Visit this listener
238 $visitorInstance->visitListener($this);
240 // Visit the pool if set
241 if ($this->getPoolInstance() instanceof Poolable) {
242 $this->getPoolInstance()->accept($visitorInstance);
246 //* DEBUG: */ $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited - FINISHED');