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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007 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 #include <omnithread.h>
  28 #include <sys/socket.h>
  29 #include <arpa/inet.h>
  30
  31 class gr_udp_sink;
  32 typedef boost::shared_ptr<gr_udp_sink> gr_udp_sink_sptr;
  33
  34 gr_udp_sink_sptr
  35 gr_make_udp_sink (size_t itemsize,
  36                   const char *src, unsigned short port_src,
  37                   const char *dst, unsigned short port_dst,
  38                   int payload_size=1472);
  39
  40 /*!
  41  * \brief Write stream to an UDP socket.
  42  * \ingroup sink
  43  *
  44  * \param itemsize     The size (in bytes) of the item datatype
  45  * \param src          The source address as either the host name or the 'numbers-and-dots'
  46  *                     IP address
  47  * \param port_src     Destination port to bind to (0 allows socket to choose an appropriate port)
  48  * \param dst          The destination address as either the host name or the 'numbers-and-dots'
  49  *                     IP address
  50  * \param port_dst     Destination port to connect to
  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 class gr_udp_sink : public gr_sync_block
  56 {
  57   friend gr_udp_sink_sptr gr_make_udp_sink (size_t itemsize,
  58                                             const char *src, unsigned short port_src,
  59                                             const char *dst, unsigned short port_dst,
  60                                             int payload_size);
  61  private:
  62   size_t        d_itemsize;
  63   bool          d_updated;
  64   omni_mutex    d_mutex;
  65
  66   int            d_payload_size;    // maximum transmission unit (packet length)
  67   int            d_socket;          // handle to socket
  68   int            d_socket_rcv;      // handle to socket retuned in the accept call
  69   struct in_addr d_ip_src;          // store the source ip info
  70   struct in_addr d_ip_dst;          // store the destination ip info
  71   unsigned short d_port_src;        // the port number to open for connections to this service
  72   unsigned short d_port_dst;        // port number of the remove system
  73   sockaddr_in    d_sockaddr_src;    // store the source sockaddr data (formatted IP address and port number)
  74   sockaddr_in    d_sockaddr_dst;    // store the destination sockaddr data (formatted IP address and port number)
  75
  76  protected:
  77   /*!
  78    * \brief UDP Sink Constructor
  79    *
  80    * \param itemsize     The size (in bytes) of the item datatype
  81    * \param src          The source address as either the host name or the 'numbers-and-dots'
  82    *                     IP address
  83    * \param port_src     Destination port to bind to (0 allows socket to choose an appropriate port)
  84    * \param dst          The destination address as either the host name or the 'numbers-and-dots'
  85    *                     IP address
  86    * \param port_dst     Destination port to connect to
  87    * \param payload_size UDP payload size by default set to
  88    *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  89    */
  90   gr_udp_sink (size_t itemsize,
  91                const char *src, unsigned short port_src,
  92                const char *dst, unsigned short port_dst,
  93                int payload_size);
  94
  95  public:
  96   ~gr_udp_sink ();
  97
  98   /*!
  99    * \brief open a socket specified by the port and ip address info
 100    *
 101    * Opens a socket, binds to the address, and makes connectionless association
 102    * over UDP. If any of these fail, the fuction retuns the error and exits.
 103    */
 104   bool open();
 105
 106   /*!
 107    * \brief Close current socket.
 108    *
 109    * Shuts down read/write on the socket
 110    */
 111   void close();
 112
 113   /*! \brief return the PAYLOAD_SIZE of the socket */
 114   int payload_size() { return d_payload_size; }
 115
 116   // should we export anything else?
 117
 118   int work (int noutput_items,
 119             gr_vector_const_void_star &input_items,
 120             gr_vector_void_star &output_items);
 121 };
 122
 123 #endif /* INCLUDED_GR_UDP_SINK_H */