[Commit-gnuradio] r4431 - gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io

[trondeau]

Author: trondeau
Date: 2007-02-08 08:26:45 -0700 (Thu, 08 Feb 2007)
New Revision: 4431

Modified:
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.cc
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.i
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.i
Log:
improving documentation; misnomer 'mtu' now called 'payload_size'

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.cc
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.cc
   2007-02-08 15:26:17 UTC (rev 4430)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.cc
   2007-02-08 15:26:45 UTC (rev 4431)
@@ -29,11 +29,11 @@
 gr_udp_sink::gr_udp_sink (size_t itemsize, 
                          const char *ipaddrl, unsigned short portl,
                          const char *ipaddrr, unsigned short portr,
-                         int mtu)
+                         int payload_size)
   : gr_sync_block ("udp_sink",
                   gr_make_io_signature (1, 1, itemsize),
                   gr_make_io_signature (0, 0, 0)),
-    d_itemsize (itemsize), d_updated(false), d_mtu(mtu)
+    d_itemsize (itemsize), d_updated(false), d_payload_size(payload_size)
 {
   // Set up the address stucture for the local address and port numbers
   inet_aton(ipaddrl, &d_ipaddr_local);     // format IP address
@@ -58,12 +58,12 @@
 gr_make_udp_sink (size_t itemsize, 
                  const char *ipaddrl, unsigned short portl,
                  const char *ipaddrr, unsigned short portr,
-                 int mtu)
+                 int payload_size)
 {
   return gr_udp_sink_sptr (new gr_udp_sink (itemsize, 
                                            ipaddrl, portl,
                                            ipaddrr, portr,
-                                           mtu));
+                                           payload_size));
 }
 
 gr_udp_sink::~gr_udp_sink ()
@@ -140,7 +140,7 @@
   #endif
 
   while(bytes_sent <  total_size) {
-    bytes_to_send = std::min(d_mtu, (total_size-bytes_sent));
+    bytes_to_send = std::min(d_payload_size, (total_size-bytes_sent));
   
     r = send(d_socket, (in+bytes_sent), bytes_to_send, 0);
     if(r == -1) {         // error on send command

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
    2007-02-08 15:26:17 UTC (rev 4430)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
    2007-02-08 15:26:45 UTC (rev 4431)
@@ -32,32 +32,34 @@
 typedef boost::shared_ptr<gr_udp_sink> gr_udp_sink_sptr;
 
 /*!
- * \brief Write stream to an Udp port (over UDP).
+ * \brief Write stream to an UDP port (over UDP).
  * \ingroup sink
+ * 
  * source
- * destination
- * domain name
- * mtu size (default=1500)
+ * \param port_src     Destination port to bind to (0 allows socket to choose 
an appropriate port)
+ * \param port_dst     Destination port to connect to
+ * \param payload_size UDP payload size by default set to 
+                           1472 = (1500 PAYLOAD_SIZE - (8 byte UDP header) - 
(20 byte IP header))
  */
 
 gr_udp_sink_sptr
 gr_make_udp_sink (size_t itemsize, 
-                 const char *ipaddrl, unsigned short portl,
-                 const char *ipaddrr, unsigned short portr,
-                 int mtu=540);
+                 const char *ipaddrl, unsigned short port_src,
+                 const char *ipaddrr, unsigned short port_dst,
+                 int payload_size=1472);
 
 class gr_udp_sink : public gr_sync_block
 {
   friend gr_udp_sink_sptr gr_make_udp_sink (size_t itemsize, 
                                            const char *ipaddrl, unsigned short 
portl,
                                            const char *ipaddrr, unsigned short 
portr,
-                                           int mtu);
+                                           int payload_size);
  private:
   size_t       d_itemsize;
   bool         d_updated;
   omni_mutex   d_mutex;
 
-  int            d_mtu;             // maximum transmission unit (packet 
length)
+  int            d_payload_size;             // 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
@@ -71,7 +73,7 @@
   gr_udp_sink (size_t itemsize, 
               const char *ipaddrl, unsigned short portl,
               const char *ipaddrr, unsigned short portr,
-              int mtu);
+              int payload_size);
 
  public:
   ~gr_udp_sink ();
@@ -91,8 +93,8 @@
    */
   void close();
 
-  /*! \brief return the MTU of the socket */
-  int mtu() { return d_mtu; }
+  /*! \brief return the PAYLOAD_SIZE of the socket */
+  int payload_size() { return d_payload_size; }
 
   // should we export anything else?
 

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.i
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.i
    2007-02-08 15:26:17 UTC (rev 4430)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.i
    2007-02-08 15:26:45 UTC (rev 4431)
@@ -27,7 +27,7 @@
 gr_make_udp_sink (size_t itemsize, 
                  const char *ipaddrl, unsigned short portl,
                  const char *ipaddrr, unsigned short portr,
-                 int mtu=540);
+                 int payload_size=1472);
 
 class gr_udp_sink : public gr_sync_block
 {
@@ -35,11 +35,11 @@
   gr_udp_sink (size_t itemsize, 
               const char *ipaddrl, unsigned short portl,
               const char *ipaddrr, unsigned short portr,
-              int mtu);
+              int payload_size);
 
   bool open();
   void close();
-  int mtu() { return d_mtu; }
+  int payload_size() { return d_payload_size; }
 
  public:
   ~gr_udp_sink ();

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
  2007-02-08 15:26:17 UTC (rev 4430)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
  2007-02-08 15:26:45 UTC (rev 4431)
@@ -31,20 +31,29 @@
 class gr_udp_source;
 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
 
+/*!
+ * \brief Write stream to an UDP port (over UDP).
+ * \ingroup sink
+ * 
+ * \param port The port number on which the socket listens for data
+ * \param payload_size  Slight misnomer; this is not the ethernet PAYLOAD_SIZE 
but the UDP payload size;
+ *             by default it is set to 1472 (1500 PAYLOAD_SIZE - (8 byte UDP 
header) - (20 byte IP header))
+ */
+ 
 gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *ipaddr, 
-                                     unsigned short port, int mtu=540);
+                                     unsigned short port, int 
payload_size=1472);
 
 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, int mtu);
+                                              unsigned short port, int 
payload_size);
 
  private:
   size_t       d_itemsize;
   bool         d_updated;
   omni_mutex   d_mutex;
 
-  int            d_mtu;           // maximum transmission unit (packet length)
+  int            d_payload_size;           // 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
@@ -59,7 +68,7 @@
   size_t d_temp_offset; // point to temp buffer location offset
 
  protected:
-  gr_udp_source(size_t itemsize, const char *ipaddr, unsigned short port, int 
mtu);
+  gr_udp_source(size_t itemsize, const char *ipaddr, unsigned short port, int 
payload_size);
 
  public:
   ~gr_udp_source();
@@ -79,8 +88,8 @@
    */
   void close();
 
-  /*! \brief return the MTU of the socket */
-  int mtu() { return d_mtu; }
+  /*! \brief return the PAYLOAD_SIZE of the socket */
+  int payload_size() { return d_payload_size; }
 
   // should we export anything else?
 

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.i
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.i
  2007-02-08 15:26:17 UTC (rev 4430)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.i
  2007-02-08 15:26:45 UTC (rev 4431)
@@ -24,19 +24,19 @@
 
 gr_udp_source_sptr 
 gr_make_udp_source (size_t itemsize, const char *ipaddr, 
-                   unsigned short port, int mtu=540);
+                   unsigned short port, int payload_size=1472);
 
 class gr_udp_source : public gr_sync_block
 {
  protected:
   gr_udp_source (size_t itemsize, const char *ipaddr, 
-                unsigned short port, int mtu);
+                unsigned short port, int payload_size);
 
  public:
   ~gr_udp_source ();
 
   bool open();
   void close();
-  int mtu() { return d_mtu; }
+  int payload_size() { return d_payload_size; }
 
 };