git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/gr_udp_source.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_GR_UDP_SOURCE_H
  24 #define INCLUDED_GR_UDP_SOURCE_H
  25
  26 #include <gr_sync_block.h>
  27 #include <omnithread.h>
  28 #include <sys/socket.h>
  29 #include <arpa/inet.h>
  30
  31 class gr_udp_source;
  32 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
  33
  34 gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src,
  35                                       unsigned short port_src, int payload_size=1472);
  36
  37 /*!
  38  * \brief Read stream from an UDP socket.
  39  * \ingroup sink
  40  *
  41  * \param itemsize     The size (in bytes) of the item datatype
  42  * \param src          The source address as either the host name or the 'numbers-and-dots'
  43  *                     IP address
  44  * \param port_src     The port number on which the socket listens for data
  45  * \param payload_size UDP payload size by default set to
  46  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  47  *
  48 */
  49
  50 class gr_udp_source : public gr_sync_block
  51 {
  52   friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src,
  53                                                unsigned short port_src, int payload_size);
  54
  55  private:
  56   size_t        d_itemsize;
  57   bool          d_updated;
  58   omni_mutex    d_mutex;
  59
  60   int            d_payload_size;  // maximum transmission unit (packet length)
  61   int            d_socket;        // handle to socket
  62   int            d_socket_rcv;    // handle to socket retuned in the accept call
  63   struct in_addr d_ip_src;        // store the source IP address to use
  64   unsigned short d_port_src;      // the port number to open for connections to this service
  65   sockaddr_in    d_sockaddr_src;  // store the source sockaddr data (formatted IP address and port number)
  66
  67   char *d_temp_buff;    // hold buffer between calls
  68   ssize_t d_residual;   // hold information about number of bytes stored in the temp buffer
  69   size_t d_temp_offset; // point to temp buffer location offset
  70
  71  protected:
  72   /*!
  73    * \brief UDP Source Constructor
  74    *
  75    * \param itemsize     The size (in bytes) of the item datatype
  76    * \param src          The source address as either the host name or the 'numbers-and-dots'
  77    *                     IP address
  78    * \param port_src     The port number on which the socket listens for data
  79    * \param payload_size UDP payload size by default set to
  80    *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  81    */
  82   gr_udp_source(size_t itemsize, const char *src, unsigned short port_src, int payload_size);
  83
  84  public:
  85   ~gr_udp_source();
  86
  87   /*!
  88    * \brief open a socket specified by the port and ip address info
  89    *
  90    * Opens a socket, binds to the address, and waits for a connection
  91    * over UDP. If any of these fail, the fuction retuns the error and exits.
  92    */
  93   bool open();
  94
  95   /*!
  96    * \brief Close current socket.
  97    *
  98    * Shuts down read/write on the socket
  99    */
 100   void close();
 101
 102   /*! \brief return the PAYLOAD_SIZE of the socket */
 103   int payload_size() { return d_payload_size; }
 104
 105   // should we export anything else?
 106
 107   int work(int noutput_items,
 108            gr_vector_const_void_star &input_items,
 109            gr_vector_void_star &output_items);
 110 };
 111
 112
 113 #endif /* INCLUDED_GR_UDP_SOURCE_H */