Merge remote branch 'gnuradio/wip/udp_source_sink'
[debian/gnuradio] / gnuradio-core / src / lib / io / gr_udp_source.h
index 162eef7d640e2b9a2a6293b2327d49398132e139..e23231aa77adf5aa296a70fbd479a9411596c557 100644 (file)
@@ -1,12 +1,12 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2004 Free Software Foundation, Inc.
+ * Copyright 2007,2008,2009,2010 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
  * GNU Radio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
+ * the Free Software Foundation; either version 3, or (at your option)
  * any later version.
  * 
  * GNU Radio is distributed in the hope that it will be useful,
 #define INCLUDED_GR_UDP_SOURCE_H
 
 #include <gr_sync_block.h>
-#include <omnithread.h>
-#include <sys/socket.h>
-#include <arpa/inet.h>
+#include <gruel/thread.h>
 
 class gr_udp_source;
 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
 
-gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *ipaddr, 
-                                     unsigned short port, unsigned int mtu=540);
+gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *host, 
+                                     unsigned short port,
+                                     int payload_size=1472,
+                                     bool eof=true, bool wait=true);
+
+/*! 
+ * \brief Read stream from an UDP socket.
+ * \ingroup source_blk
+ *
+ * \param itemsize     The size (in bytes) of the item datatype
+ * \param host         The name or IP address of the receiving host; can be
+ *                     NULL, None, or "0.0.0.0" to allow reading from any
+ *                     interface on the host
+ * \param port         The port number on which to receive data; use 0 to
+ *                     have the system assign an unused port number
+ * \param payload_size UDP payload size by default set to 1472 =
+ *                     (1500 MTU - (8 byte UDP header) - (20 byte IP header))
+ * \param eof          Interpret zero-length packet as EOF (default: true)
+ * \param wait         Wait for data if not immediately available
+ *                     (default: true)
+ *
+*/
 
 class gr_udp_source : public gr_sync_block
 {
-  friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *ipaddr, 
-                                              unsigned short port, unsigned int mtu);
+  friend gr_udp_source_sptr gr_make_udp_source(size_t itemsize,
+                                              const char *host, 
+                                              unsigned short port,
+                                              int payload_size,
+                                              bool eof, bool wait);
 
  private:
   size_t       d_itemsize;
-  bool         d_updated;
-  omni_mutex   d_mutex;
+  int           d_payload_size;  // maximum transmission unit (packet length)
+  bool          d_eof;           // zero-length packet is EOF
+  bool          d_wait;          // wait if data if not immediately available
+  int           d_socket;        // handle to socket
+  char *d_temp_buff;    // hold buffer between calls
+  ssize_t d_residual;   // hold information about number of bytes stored in the temp buffer
+  size_t d_temp_offset; // point to temp buffer location offset
 
-  unsigned int   d_mtu;           // maximum transmission unit (packet length)
-  int            d_socket;        // handle to socket
-  int            d_socket_rcv;    // handle to socket retuned in the accept call
-  struct in_addr d_ipaddr_local;  // store the local IP address to use
-  struct in_addr d_ipaddr_remote; // store the remote IP address that connected to us
-  unsigned short d_port_local;    // the port number to open for connections to this service
-  unsigned short d_port_remote;   // port number of the remove system
-  sockaddr_in    d_sockaddr_local;  // store the local sockaddr data (formatted IP address and port number)
-  sockaddr_in    d_sockaddr_remote; // store the remote sockaddr data (formatted IP address and port number)
-  
  protected:
-  gr_udp_source(size_t itemsize, const char *ipaddr, unsigned short port, unsigned int mtu);
-
- public:
-  ~gr_udp_source();
-
   /*!
-   * \brief open a socket specified by the port and ip address info
-   *
-   * Opens a socket, binds to the address, and waits for a connection
-   * over UDP. If any of these fail, the fuction retuns the error and exits.
+   * \brief UDP Source Constructor
+   * 
+   * \param itemsize     The size (in bytes) of the item datatype
+   * \param host         The name or IP address of the receiving host; can be
+   *                     NULL, None, or "0.0.0.0" to allow reading from any
+   *                     interface on the host
+   * \param port         The port number on which to receive data; use 0 to
+   *                     have the system assign an unused port number
+   * \param payload_size UDP payload size by default set to 1472 =
+   *                     (1500 MTU - (8 byte UDP header) - (20 byte IP header))
+   * \param eof          Interpret zero-length packet as EOF (default: true)
+   * \param wait         Wait for data if not immediately available
+   *                     (default: true)
    */
-  bool open();
+  gr_udp_source(size_t itemsize, const char *host, unsigned short port,
+               int payload_size, bool eof, bool wait);
 
-  /*!
-   * \brief Close current socket.
-   *
-   * Shuts down read/write on the socket
-   */
-  void close();
+ public:
+  ~gr_udp_source();
 
-  /*! \brief set the MTU of the socket */
-  void set_mtu(unsigned int mtu) { d_mtu = mtu; }
+  /*! \brief return the PAYLOAD_SIZE of the socket */
+  int payload_size() { return d_payload_size; }
 
-  /*! \brief return the MTU of the socket */
-  unsigned int mtu() { return d_mtu; }
+  /*! \breif return the port number of the socket */
+  int get_port();
 
   // should we export anything else?