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