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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007,2008,2009,2010 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,
  42                                       int payload_size=1472, bool wait=true);
  43
  44 /*!
  45  * \brief Read stream from an UDP socket.
  46  * \ingroup source_blk
  47  *
  48  * \param itemsize     The size (in bytes) of the item datatype
  49  * \param src          The source address as either the host name or the 'numbers-and-dots'
  50  *                     IP address
  51  * \param port_src     The port number on which the socket listens for data
  52  * \param payload_size UDP payload size by default set to
  53  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  54  * \param wait         Wait for data if not immediately available (default: true)
  55  *
  56 */
  57
  58 class gr_udp_source : public gr_sync_block
  59 {
  60   friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src,
  61                                                unsigned short port_src,
  62                                                int payload_size, bool wait);
  63
  64  private:
  65   size_t        d_itemsize;
  66
  67   int            d_payload_size;  // maximum transmission unit (packet length)
  68   bool           d_wait;          // wait if data if not immediately available
  69   int            d_socket;        // handle to socket
  70   char *d_temp_buff;    // hold buffer between calls
  71   ssize_t d_residual;   // hold information about number of bytes stored in the temp buffer
  72   size_t d_temp_offset; // point to temp buffer location offset
  73
  74  protected:
  75   /*!
  76    * \brief UDP Source Constructor
  77    *
  78    * \param itemsize     The size (in bytes) of the item datatype
  79    * \param src          The source address as either the host name or the 'numbers-and-dots'
  80    *                     IP address
  81    * \param port_src     The port number on which the socket listens for data
  82    * \param payload_size UDP payload size by default set to
  83    *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  84    * \param wait         Wait for data if not immediately available (default: true)
  85    */
  86   gr_udp_source(size_t itemsize, const char *src, unsigned short port_src,
  87                 int payload_size, bool wait);
  88
  89  public:
  90   ~gr_udp_source();
  91
  92   /*! \brief return the PAYLOAD_SIZE of the socket */
  93   int payload_size() { return d_payload_size; }
  94
  95   // should we export anything else?
  96
  97   int work(int noutput_items,
  98            gr_vector_const_void_star &input_items,
  99            gr_vector_void_star &output_items);
 100 };
 101
 102
 103 #endif /* INCLUDED_GR_UDP_SOURCE_H */