3 * An UDP connection listener
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 UdpListener extends BaseListener implements Listenable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set the protocol to UDP
35 $this->setProtocol('udp');
39 * Creates an instance of this class
41 * @param $nodeInstance A NodeHelper instance
42 * @return $listenerInstance An instance a prepared listener class
44 public static final function createUdpListener (NodeHelper $nodeInstance) {
46 $listenerInstance = new UdpListener();
48 // Set the application instance
49 $listenerInstance->setNodeInstance($nodeInstance);
51 // Return the prepared instance
52 return $listenerInstance;
56 * Initializes the listener by setting up the required socket server
59 * @throws InvalidSocketException Thrown if the socket is invalid or an
62 public function initListener () {
63 // Try to open a UDP socket
64 $mainSocket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
66 // Is the socket a valid resource or do we have any error?
67 if (!is_resource($mainSocket)) {
68 // Then throw an InvalidSocketException
69 throw new InvalidSocketException(array($this, $mainSocket), BaseListener::EXCEPTION_INVALID_SOCKET);
72 // Set the option to reuse the port
73 $this->debugOutput('UDP-LISTENER: Setting re-use address option.');
74 if (!socket_set_option($mainSocket, SOL_SOCKET, SO_REUSEADDR, 1)) {
75 // Handle the socket error with a faked recipientData array
76 $this->handleSocketError($mainSocket, array('0.0.0.0', '0'));
78 // Get socket error code for verification
79 $socketError = socket_last_error($mainSocket);
82 $errorMessage = socket_strerror($socketError);
84 // Shutdown this socket
85 $this->shutdownSocket($mainSocket);
88 throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
92 // "Bind" the socket to the given address, on given port so this means
93 // that all connections on this port are now our resposibility to
94 // send/recv data, disconnect, etc..
95 $this->debugOutput('UDP-LISTENER: Binding to address ' . $this->getListenAddress() . ':' . $this->getListenPort());
96 if (!socket_bind($mainSocket, $this->getListenAddress(), $this->getListenPort())) {
97 // Handle the socket error with a faked recipientData array
98 $this->handleSocketError($mainSocket, array('0.0.0.0', '0'));
100 // Get socket error code for verification
101 $socketError = socket_last_error($mainSocket);
104 $errorMessage = socket_strerror($socketError);
106 // Shutdown this socket
107 $this->shutdownSocket($mainSocket);
110 throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
114 // Now, we want non-blocking mode
115 $this->debugOutput('UDP-LISTENER: Setting non-blocking mode.');
116 if (!socket_set_nonblock($mainSocket)) {
117 // Handle the socket error with a faked recipientData array
118 $this->handleSocketError($mainSocket, array('0.0.0.0', '0'));
120 // Get socket error code for verification
121 $socketError = socket_last_error($socket);
124 $errorMessage = socket_strerror($socketError);
126 // Shutdown this socket
127 $this->shutdownSocket($mainSocket);
130 throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
134 // Remember the socket in our class
135 $this->registerServerSocketResource($mainSocket);
137 // Initialize the network package handler
138 $handlerInstance = ObjectFactory::createObjectByConfiguredName('udp_raw_data_handler_class');
140 // Set it in this class
141 $this->setHandlerInstance($handlerInstance);
144 $this->debugOutput('UDP-LISTENER: UDP listener now ready on IP ' . $this->getListenAddress() . ', port ' . $this->getListenPort() . ' for service.');
148 * "Listens" for incoming network packages
153 public function doListen() {
154 // Read a package and determine the peer
155 $amount = @socket_recvfrom($this->getSocketResource(), $pkt, 1500, 0, $peer, $port);
158 $lastError = socket_last_error($this->getSocketResource());
160 // Do we have an error at the line?
161 if ($lastError == 11) {
163 * This (resource temporary unavailable) can be safely ignored on
164 * "listening" UDP ports. If we don't clear the error here, our UDP
165 * "listener" won't read any packages except if the UDP sender
166 * starts the transmission before this "listener came up...
168 socket_clear_error($this->getSocketResource());
170 // Skip further processing
172 } elseif ($lastError > 0) {
173 // Other error detected
174 $this->debugOutput('UDP-LISTENER: Error detected: ' . socket_strerror($lastError));
176 // Skip further processing
178 } elseif ((empty($pkt)) || (trim($peer) == '')) {
179 // Zero sized packages/peer names are usual in non-blocking mode
184 $this->debugOutput('UDP-LISTENER: Handling UDP package with size ' . strlen($pkt) . ' from peer ' . $peer . ':' . $port);
188 * Checks whether the listener would accept the given package data array
190 * @param $packageData Raw package data
191 * @return $accepts Whether this listener does accept
193 function ifListenerAcceptsPackageData (array $packageData) {
194 $this->partialStub('This call should not happen. Please report it.');