application/hub/main/listener/udp/class_UdpListener.php

   1 <?php
   2 /**
   3  * An UDP connection listener
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class UdpListener extends BaseListener implements Listenable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set the protocol to UDP
  35                 $this->setProtocol('udp');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $nodeInstance           A NodeHelper instance
  42          * @return      $listenerInstance       An instance a prepared listener class
  43          */
  44         public static final function createUdpListener (NodeHelper $nodeInstance) {
  45                 // Get new instance
  46                 $listenerInstance = new UdpListener();
  47
  48                 // Set the application instance
  49                 $listenerInstance->setNodeInstance($nodeInstance);
  50
  51                 // Return the prepared instance
  52                 return $listenerInstance;
  53         }
  54
  55         /**
  56          * Initializes the listener by setting up the required socket server
  57          *
  58          * @return      void
  59          * @throws      InvalidSocketException  Thrown if the socket is invalid or an
  60          *                                                                      error was detected.
  61          */
  62         public function initListener () {
  63                 // Try to open a UDP socket
  64                 $mainSocket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
  65
  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);
  70                 } // END - if
  71
  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'));
  77                         /*
  78                         // Get socket error code for verification
  79                         $socketError = socket_last_error($mainSocket);
  80
  81                         // Get error message
  82                         $errorMessage = socket_strerror($socketError);
  83
  84                         // Shutdown this socket
  85                         $this->shutdownSocket($mainSocket);
  86
  87                         // And throw again
  88                         throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
  89                         */
  90                 } // END - if
  91
  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'));
  99                         /*
 100                         // Get socket error code for verification
 101                         $socketError = socket_last_error($mainSocket);
 102
 103                         // Get error message
 104                         $errorMessage = socket_strerror($socketError);
 105
 106                         // Shutdown this socket
 107                         $this->shutdownSocket($mainSocket);
 108
 109                         // And throw again
 110                         throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 111                         */
 112                 } // END - if
 113
 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'));
 119                         /*
 120                         // Get socket error code for verification
 121                         $socketError = socket_last_error($socket);
 122
 123                         // Get error message
 124                         $errorMessage = socket_strerror($socketError);
 125
 126                         // Shutdown this socket
 127                         $this->shutdownSocket($mainSocket);
 128
 129                         // And throw again
 130                         throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 131                         */
 132                 } // END - if
 133
 134                 // Remember the socket in our class
 135                 $this->registerServerSocketResource($mainSocket);
 136
 137                 // Initialize the network package handler
 138                 $handlerInstance = ObjectFactory::createObjectByConfiguredName('udp_raw_data_handler_class');
 139
 140                 // Set it in this class
 141                 $this->setHandlerInstance($handlerInstance);
 142
 143                 // Output message
 144                 $this->debugOutput('UDP-LISTENER: UDP listener now ready on IP ' . $this->getListenAddress() . ', port ' . $this->getListenPort() . ' for service.');
 145         }
 146
 147         /**
 148          * "Listens" for incoming network packages
 149          *
 150          * @return      void
 151          * @todo        ~50% done
 152          */
 153         public function doListen() {
 154                 // Read a package and determine the peer
 155                 $amount = @socket_recvfrom($this->getSocketResource(), $rawData, $this->getConfigInstance()->getConfigEntry('udp_buffer_length'), MSG_DONTWAIT, $peer, $port);
 156
 157                 // Get last error
 158                 $lastError = socket_last_error($this->getSocketResource());
 159
 160                 // Do we have an error at the line?
 161                 if ($lastError == 11) {
 162                         /*
 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...
 167                          */
 168                         socket_clear_error($this->getSocketResource());
 169
 170                         // Skip further processing
 171                         return;
 172                 } elseif ($lastError > 0) {
 173                         // Other error detected
 174                         $this->debugOutput('UDP-LISTENER: Error detected: ' . socket_strerror($lastError));
 175
 176                         // Skip further processing
 177                         return;
 178                 } elseif ((empty($rawData)) || (trim($peer) == '')) {
 179                         // Zero sized packages/peer names are usual in non-blocking mode
 180                         return;
 181                 } // END - if
 182
 183                 // Debug only
 184                 $this->debugOutput('UDP-LISTENER: Handling UDP package with size ' . strlen($rawData) . ' from peer ' . $peer . ':' . $port);
 185         }
 186
 187         /**
 188          * Checks whether the listener would accept the given package data array
 189          *
 190          * @param       $packageData    Raw package data
 191          * @return      $accepts                Whether this listener does accept
 192          */
 193         function ifListenerAcceptsPackageData (array $packageData) {
 194                 $this->partialStub('This call should not happen. Please report it.');
 195         }
 196 }
 197
 198 // [EOF]
 199 ?>