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