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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007,2008,2009 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 #if defined(HAVE_NETDB_H)
  28 #include <netdb.h>
  29 #include <sys/socket.h>  // usually #included by <netdb.h>?
  30 #elif defined(HAVE_WINDOWS_H)
  31 #include <winsock2.h>
  32 #include <ws2tcpip.h>
  33 #endif
  34
  35 #include <gruel/thread.h>
  36
  37 class gr_udp_source;
  38 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
  39
  40 gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src,
  41                                       unsigned short port_src, int payload_size=1472);
  42
  43 /*!
  44  * \brief Read stream from an UDP socket.
  45  * \ingroup source_blk
  46  *
  47  * \param itemsize     The size (in bytes) of the item datatype
  48  * \param src          The source address as either the host name or the 'numbers-and-dots'
  49  *                     IP address
  50  * \param port_src     The port number on which the socket listens for data
  51  * \param payload_size UDP payload size by default set to
  52  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  53  *
  54 */
  55
  56 class gr_udp_source : public gr_sync_block
  57 {
  58   friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src,
  59                                                unsigned short port_src, int payload_size);
  60
  61  private:
  62   size_t        d_itemsize;
  63   bool          d_updated;
  64   gruel::mutex  d_mutex;
  65
  66   int            d_payload_size;  // maximum transmission unit (packet length)
  67   int            d_socket;        // handle to socket
  68   struct addrinfo *d_ip_src;      // store the source IP address to use
  69   char *d_temp_buff;    // hold buffer between calls
  70   ssize_t d_residual;   // hold information about number of bytes stored in the temp buffer
  71   size_t d_temp_offset; // point to temp buffer location offset
  72
  73  protected:
  74   /*!
  75    * \brief UDP Source Constructor
  76    *
  77    * \param itemsize     The size (in bytes) of the item datatype
  78    * \param src          The source address as either the host name or the 'numbers-and-dots'
  79    *                     IP address
  80    * \param port_src     The port number on which the socket listens for data
  81    * \param payload_size UDP payload size by default set to
  82    *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  83    */
  84   gr_udp_source(size_t itemsize, const char *src, unsigned short port_src, int payload_size);
  85
  86  public:
  87   ~gr_udp_source();
  88
  89   /*!
  90    * \brief open a socket specified by the port and ip address info
  91    *
  92    * Opens a socket, binds to the address, and waits for a connection
  93    * over UDP. If any of these fail, the fuction retuns the error and exits.
  94    */
  95   bool open();
  96
  97   /*!
  98    * \brief Close current socket.
  99    *
 100    * Shuts down read/write on the socket
 101    */
 102   void close();
 103
 104   /*! \brief return the PAYLOAD_SIZE of the socket */
 105   int payload_size() { return d_payload_size; }
 106
 107   // should we export anything else?
 108
 109   int work(int noutput_items,
 110            gr_vector_const_void_star &input_items,
 111            gr_vector_void_star &output_items);
 112 };
 113
 114
 115 #endif /* INCLUDED_GR_UDP_SOURCE_H */