diff options
| author | Martin Braun <martin.braun@ettus.com> | 2016-10-26 13:37:27 -0700 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2016-10-26 13:37:27 -0700 |
| commit | 6711c7df3dd115a2b443448e98f7741595220228 (patch) | |
| tree | 9d871827fcb656a93ee0965d7c0bbd1a0967494d /host | |
| parent | fb5c365396d608dd0f4703a203343300ac1efb51 (diff) | |
| download | uhd-6711c7df3dd115a2b443448e98f7741595220228.tar.gz uhd-6711c7df3dd115a2b443448e98f7741595220228.tar.bz2 uhd-6711c7df3dd115a2b443448e98f7741595220228.zip | |
docs: Fixed notes on transport parameters
Diffstat (limited to 'host')
| -rw-r--r-- | host/docs/transport.dox | 5 | ||||
| -rw-r--r-- | host/include/uhd/stream.hpp | 13 |
2 files changed, 3 insertions, 15 deletions
diff --git a/host/docs/transport.dox b/host/docs/transport.dox index 2cedcccb2..3922efa85 100644 --- a/host/docs/transport.dox +++ b/host/docs/transport.dox @@ -22,14 +22,15 @@ standard Berkeley sockets API using `send()`/`recv()`. The following parameters can be used to alter the transport's default 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): +at initialization time, see also \ref config_devaddr): - `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 targeted fullness factor of the the buffer (typically around 90%) +- `ups_per_sec`: USRP2 only. Flow control ACKs per second on TX. +- `ups_per_fifo`: USRP2 only. Flow control ACKs per total buffer size (in packets) on TX. <b>Notes:</b> - `num_recv_frames` does not affect performance. diff --git a/host/include/uhd/stream.hpp b/host/include/uhd/stream.hpp index 0dfc94c86..7b6cc79b3 100644 --- a/host/include/uhd/stream.hpp +++ b/host/include/uhd/stream.hpp @@ -134,19 +134,6 @@ struct UHD_API stream_args_t{ * - function: magnitude or phase/magnitude * - units: numeric units like counts or dBm * - * In addition, all the transport-related options explained on \ref page_transport can be set here. - * These options can be set either when creating the device (see also \ref config_devaddr), - * or when creating the streamer (when the options are given both times, the stream args - * take precedence): - * - * - recv_frame_size - * - send_frame_size - * - num_recv_frames - * - num_send_frames - * - ups_per_sec - * - ups_per_fifo - * - recv_buff_fullness - * * Other options are device-specific: * - port, addr: Alternative receiver streamer destination. */ |