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