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

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