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 #include <gruel/thread.h>
  28
  29 class gr_udp_source;
  30 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
  31
  32 gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *host,
  33                                       unsigned short port,
  34                                       int payload_size=1472,
  35                                       bool eof=true, bool wait=true);
  36
  37 /*!
  38  * \brief Read stream from an UDP socket.
  39  * \ingroup source_blk
  40  *
  41  * \param itemsize     The size (in bytes) of the item datatype
  42  * \param host         The name or IP address of the receiving host; can be
  43  *                     NULL, None, or "0.0.0.0" to allow reading from any
  44  *                     interface on the host
  45  * \param port         The port number on which to receive data; use 0 to
  46  *                     have the system assign an unused port number
  47  * \param payload_size UDP payload size by default set to 1472 =
  48  *                     (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  49  * \param eof          Interpret zero-length packet as EOF (default: true)
  50  * \param wait         Wait for data if not immediately available
  51  *                     (default: true)
  52  *
  53 */
  54
  55 class gr_udp_source : public gr_sync_block
  56 {
  57   friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize,
  58                                                const char *host,
  59                                                unsigned short port,
  60                                                int payload_size,
  61                                                bool eof, bool wait);
  62
  63  private:
  64   size_t        d_itemsize;
  65   int           d_payload_size;  // maximum transmission unit (packet length)
  66   bool          d_eof;           // zero-length packet is EOF
  67   bool          d_wait;          // wait if data if not immediately available
  68   int           d_socket;        // handle to socket
  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 host         The name or IP address of the receiving host; can be
  79    *                     NULL, None, or "0.0.0.0" to allow reading from any
  80    *                     interface on the host
  81    * \param port         The port number on which to receive data; use 0 to
  82    *                     have the system assign an unused port number
  83    * \param payload_size UDP payload size by default set to 1472 =
  84    *                     (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  85    * \param eof          Interpret zero-length packet as EOF (default: true)
  86    * \param wait         Wait for data if not immediately available
  87    *                     (default: true)
  88    */
  89   gr_udp_source(size_t itemsize, const char *host, unsigned short port,
  90                 int payload_size, bool eof, bool wait);
  91
  92  public:
  93   ~gr_udp_source();
  94
  95   /*! \brief return the PAYLOAD_SIZE of the socket */
  96   int payload_size() { return d_payload_size; }
  97
  98   /*! \breif return the port number of the socket */
  99   int get_port();
 100
 101   // should we export anything else?
 102
 103   int work(int noutput_items,
 104            gr_vector_const_void_star &input_items,
 105            gr_vector_void_star &output_items);
 106 };
 107
 108
 109 #endif /* INCLUDED_GR_UDP_SOURCE_H */