summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2011-02-20 01:13:03 -0800
committerJosh Blum <josh@joshknows.com>2011-02-20 01:13:03 -0800
commit2d9838f467013d5397b6daf83afb5ccea92065a4 (patch)
treecc34b6106523307a2f18eff86c3311f3458d9eb7 /host/docs
parent8ab02dbef4cb36b2419371c131ff8c8edae88ce8 (diff)
downloaduhd-2d9838f467013d5397b6daf83afb5ccea92065a4.tar.gz
uhd-2d9838f467013d5397b6daf83afb5ccea92065a4.tar.bz2
uhd-2d9838f467013d5397b6daf83afb5ccea92065a4.zip
udp: update docs for transport, create common header for wait implementation
Reimplemented simple udp transport with one impl class. Moved wait for ready/select implementation into common header. Important note on select, timeval should have usecs < 1 second or it may error on some platforms. Fixed in this implementation.
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/transport.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/host/docs/transport.rst b/host/docs/transport.rst
index 6b9d28bfa..2371d2497 100644
--- a/host/docs/transport.rst
+++ b/host/docs/transport.rst
@@ -17,13 +17,9 @@ that are known to perform well on a variety of systems.
The transport parameters are defined below for the various transports in the UHD:
------------------------------------------------------------------------
-UDP transport (ASIO)
+UDP transport (sockets)
------------------------------------------------------------------------
-The UDP transport is implemented with Boost's ASIO library.
-ASIO provides an asynchronous API for user-space sockets.
-The transport implementation allocates a number of buffers
-and submits asynchronous requests for send and receive.
-IO service threads run in the background to process these requests.
+The UDP transport is implemented with standard user-space/Berkeley sockets.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Transport parameters
@@ -35,8 +31,12 @@ The following parameters can be used to alter the transport's default behavior:
* **send_frame_size:** The size of a single send buffer in bytes
* **num_send_frames:** The number of send buffers to allocate
-**Note:** num_recv_frames and num_send_frames will not have an effect
-as the asynchronous send implementation is currently unimplemented.
+**Note1:** num_recv_frames and num_send_frames do not affect performance.
+
+**Note2:** recv_frame_size and send_frame_size can be used to
+increase or decrease the maximum number of samples per packet.
+The frame sizes default to an MTU of 1472 bytes per IP/UDP packet,
+and may be increased if permitted by your network hardware.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Flow control parameters