3 * A general listener class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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;
27 const EXCEPTION_SOCKET_ALREADY_REGISTERED = 0xa01;
30 * Used protocol (Default: invalid, which is indeed invalid...)
32 private $protocol = 'invalid';
35 * Address (IP mostly) we shall listen on
37 private $listenAddress = '0.0.0.0'; // This is the default and listens on all interfaces
40 * Port we shall listen on (or wait for incoming data)
42 private $listenPort = 0; // This port MUST be changed by your application
45 * Wether we are in blocking or non-blocking mode (default: non-blocking
47 private $blockingMode = false;
50 * A peer pool instance
52 private $poolInstance = null;
55 * Protected constructor
57 * @param $className Name of the class
60 protected function __construct ($className) {
61 // Call parent constructor
62 parent::__construct($className);
66 * Checks wether the given socket resource is a server socket
68 * @param $socketResource A valid socket resource
69 * @return $isServerSocket Wether the socket resource is a server socket
71 protected function isServerSocketResource ($socketResource) {
73 $isServerSocket = ((is_resource($socketResource)) && (!@socket_getpeername($socketResource, $peerName)));
75 // We need to clear the error here if it is a resource
76 if ($isServerSocket === true) {
78 //* DEBUG: */ $this->debugOutput('socketResource[]=' . gettype($socketResource));
79 socket_clear_error($socketResource);
82 // Check peer name, it must be empty
83 $isServerSocket = (($isServerSocket) && (empty($peerName)));
86 return $isServerSocket;
90 * Setter for listen address
92 * @param $listenAddress The address this listener should listen on
95 protected final function setListenAddress ($listenAddress) {
96 $this->listenAddress = (string) $listenAddress;
100 * Getter for listen address
102 * @return $listenAddress The address this listener should listen on
104 public final function getListenAddress () {
105 return $this->listenAddress;
109 * Setter for listen port
111 * @param $listenPort The port this listener should listen on
114 protected final function setListenPort ($listenPort) {
115 $this->listenPort = (int) $listenPort;
119 * Getter for listen port
121 * @return $listenPort The port this listener should listen on
123 public final function getListenPort () {
124 return $this->listenPort;
128 * Getter for port number to satify ProtocolHandler
130 * @return $port The port number
132 public final function getPort () {
133 return $this->getListenPort();
137 * "Setter" to set listen address from configuration entry
139 * @param $configEntry The configuration entry holding our listen address
142 public final function setListenAddressByConfiguration ($configEntry) {
143 $this->setListenAddress($this->getConfigInstance()->getConfigEntry($configEntry));
147 * "Setter" to set listen port from configuration entry
149 * @param $configEntry The configuration entry holding our listen port
152 public final function setListenPortByConfiguration ($configEntry) {
153 $this->setListenPort($this->getConfigInstance()->getConfigEntry($configEntry));
157 * Setter for protocol
159 * @param $protocol Used protocol
162 protected final function setProtocol ($protocol) {
163 $this->protocol = (string) $protocol;
167 * Getter for protocol
169 * @return $protocol Used protocol
171 public final function getProtocol () {
172 return $this->protocol;
176 * Setter for blocking-mode
178 * @param $blockingMode Wether blocking-mode is disabled (default) or enabled
181 protected final function setBlockingMode ($blockingMode) {
182 $this->blockingMode = (boolean) $blockingMode;
186 * Checks wether blocking-mode is enabled or disabled
188 * @return $blockingMode Wether blocking mode is disabled or enabled
190 public final function isBlockingModeEnabled () {
191 return $this->blockingMode;
195 * Setter for peer pool instance
197 * @param $poolInstance The peer pool instance we shall set
200 protected final function setPoolInstance (PoolablePeer $poolInstance) {
201 $this->poolInstance = $poolInstance;
205 * Getter for peer pool instance
207 * @return $poolInstance The peer pool instance we shall set
209 public final function getPoolInstance () {
210 return $this->poolInstance;
214 * Registeres the given socket resource for "this" listener instance. This
215 * will be done in a seperate class to allow package writers to use it
218 * @param $socketResource A valid server socket resource
220 * @throws InvalidServerSocketException If the given resource is no server socket
221 * @throws SocketAlreadyRegisteredException If the given resource is already registered
223 protected function registerServerSocketResource ($socketResource) {
224 // First check if it is valid
225 if (!$this->isServerSocketResource($socketResource)) {
227 throw new InvalidServerSocketException(array($this, $socketResource), self::EXCEPTION_INVALID_SOCKET);
228 } elseif ($this->isServerSocketRegistered($socketResource)) {
229 // Already registered
230 throw new SocketAlreadyRegisteredException($this, self::EXCEPTION_SOCKET_ALREADY_REGISTERED);
233 // Get a socket registry instance (singleton)
234 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
236 // Register the socket
237 $registryInstance->registerSocket($this, $socketResource);
241 * Checks wether given socket resource is registered in socket registry
243 * @param $socketResource A valid server socket resource
244 * @return $isRegistered Wether given server socket is registered
246 protected function isServerSocketRegistered ($socketResource) {
247 // Get a socket registry instance (singleton)
248 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
251 $isRegistered = $registryInstance->isSocketRegistered($this, $socketResource);
254 return $isRegistered;
258 * Getter for "this" socket resource
260 * @return $socketResource A valid socket resource
262 public final function getSocketResource () {
263 // Get a socket registry instance (singleton)
264 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
266 // Get the socket resource
267 $socketResource = $registryInstance->getRegisteredSocketResource($this);
270 return $socketResource;
274 * Accepts the visitor to process the visit "request"
276 * @param $visitorInstance An instance of a Visitor class
279 public function accept (Visitor $visitorInstance) {
281 //* DEBUG: */ $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited ' . $this->__toString() . ' - START');
283 // Visit this listener
284 $visitorInstance->visitListener($this);
286 // Visit the pool if set
287 if ($this->getPoolInstance() instanceof Poolable) {
288 $this->getPoolInstance()->accept($visitorInstance);
292 //* DEBUG: */ $this->debugOutput('LISTENER: ' . $visitorInstance->__toString() . ' has visited ' . $this->__toString() . ' - FINISHED');