git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/gr_udp_sink.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_SINK_H
  24 #define INCLUDED_GR_UDP_SINK_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_sink;
  38 typedef boost::shared_ptr<gr_udp_sink> gr_udp_sink_sptr;
  39
  40 gr_udp_sink_sptr
  41 gr_make_udp_sink (size_t itemsize,
  42                   const char *src, unsigned short port_src,
  43                   const char *dst, unsigned short port_dst,
  44                   int payload_size=1472);
  45
  46 /*!
  47  * \brief Write stream to an UDP socket.
  48  * \ingroup sink_blk
  49  *
  50  * \param itemsize     The size (in bytes) of the item datatype
  51  * \param src          The source address as either the host name or the 'numbers-and-dots'
  52  *                     IP address
  53  * \param port_src     Destination port to bind to (0 allows socket to choose an appropriate port)
  54  * \param dst          The destination address as either the host name or the 'numbers-and-dots'
  55  *                     IP address
  56  * \param port_dst     Destination port to connect to
  57  * \param payload_size UDP payload size by default set to
  58  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  59  */
  60
  61 class gr_udp_sink : public gr_sync_block
  62 {
  63   friend gr_udp_sink_sptr gr_make_udp_sink (size_t itemsize,
  64                                             const char *src, unsigned short port_src,
  65                                             const char *dst, unsigned short port_dst,
  66                                             int payload_size);
  67  private:
  68   size_t        d_itemsize;
  69   bool          d_updated;
  70   gruel::mutex  d_mutex;
  71
  72   int            d_payload_size;    // maximum transmission unit (packet length)
  73   int            d_socket;          // handle to socket
  74   struct addrinfo *d_ip_src;        // store the source ip info
  75   struct addrinfo *d_ip_dst;        // store the destination ip info
  76
  77  protected:
  78   /*!
  79    * \brief UDP Sink Constructor
  80    *
  81    * \param itemsize     The size (in bytes) of the item datatype
  82    * \param src          The source address as either the host name or the 'numbers-and-dots'
  83    *                     IP address
  84    * \param port_src     Destination port to bind to (0 allows socket to choose an appropriate port)
  85    * \param dst          The destination address as either the host name or the 'numbers-and-dots'
  86    *                     IP address
  87    * \param port_dst     Destination port to connect to
  88    * \param payload_size UDP payload size by default set to
  89    *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  90    */
  91   gr_udp_sink (size_t itemsize,
  92                const char *src, unsigned short port_src,
  93                const char *dst, unsigned short port_dst,
  94                int payload_size);
  95
  96  public:
  97   ~gr_udp_sink ();
  98
  99   /*!
 100    * \brief open a socket specified by the port and ip address info
 101    *
 102    * Opens a socket, binds to the address, and makes connectionless association
 103    * over UDP. If any of these fail, the fuction retuns the error and exits.
 104    */
 105   bool open();
 106
 107   /*!
 108    * \brief Close current socket.
 109    *
 110    * Shuts down read/write on the socket
 111    */
 112   void close();
 113
 114   /*! \brief return the PAYLOAD_SIZE of the socket */
 115   int payload_size() { return d_payload_size; }
 116
 117   // should we export anything else?
 118
 119   int work (int noutput_items,
 120             gr_vector_const_void_star &input_items,
 121             gr_vector_void_star &output_items);
 122 };
 123
 124 #endif /* INCLUDED_GR_UDP_SINK_H */