aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/transport.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2015-01-07 14:58:46 +0100
committerMartin Braun <martin.braun@ettus.com>2015-01-07 15:37:14 +0100
commita520a70c9644e7244b186d9e6089bb25659f6c80 (patch)
tree2b82414a488727bfe9b1ebf4555c371d07811569 /host/docs/transport.dox
parent2474ac3296142aa333c09c0215d6fb80c446f20e (diff)
downloaduhd-a520a70c9644e7244b186d9e6089bb25659f6c80.tar.gz
uhd-a520a70c9644e7244b186d9e6089bb25659f6c80.tar.bz2
uhd-a520a70c9644e7244b186d9e6089bb25659f6c80.zip
docs: Major revisions and additions
Diffstat (limited to 'host/docs/transport.dox')
-rw-r--r--host/docs/transport.dox5
1 files changed, 4 insertions, 1 deletions
diff --git a/host/docs/transport.dox b/host/docs/transport.dox
index 942fa9509..eb7232f36 100644
--- a/host/docs/transport.dox
+++ b/host/docs/transport.dox
@@ -21,12 +21,15 @@ standard Berkeley sockets API using send()/recv().
\subsection transport_udp_params Transport parameters
The following parameters can be used to alter the transport's default
-behavior:
+behavior (these options can be passed to a USRP device as arguments
+at initialization time, see also \ref config_devaddr, or to a streamer,
+see uhd::stream_args_t::args):
- `recv_frame_size:` The size of a single receive buffer in bytes
- `num_recv_frames:` The number of receive buffers to allocate
- `send_frame_size:` The size of a single send buffer in bytes
- `num_send_frames:` The number of send buffers to allocate
+- `recv_buff_fullness:` The targetted fullness factor of the the buffer (typically around 90%)
<b>Notes:</b>
- `num_recv_frames` does not affect performance.