diff options
author | Martin Braun <martin.braun@ettus.com> | 2016-09-23 18:10:16 -0700 |
---|---|---|
committer | Martin Braun <martin.braun@ettus.com> | 2016-09-23 18:10:16 -0700 |
commit | d6640a64bdc17f185001ea93caf6bc8b3b6a01be (patch) | |
tree | e877ee0926d9b97bc2c2ea3ba8b087d39c9310a0 /host | |
parent | 96d16901e27ff653119d52823cfe4feb7a282aff (diff) | |
download | uhd-d6640a64bdc17f185001ea93caf6bc8b3b6a01be.tar.gz uhd-d6640a64bdc17f185001ea93caf6bc8b3b6a01be.tar.bz2 uhd-d6640a64bdc17f185001ea93caf6bc8b3b6a01be.zip |
stream: Document thread-non-safety of recv()
Diffstat (limited to 'host')
-rw-r--r-- | host/include/uhd/stream.hpp | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/host/include/uhd/stream.hpp b/host/include/uhd/stream.hpp index e8f9b7b7a..0dfc94c86 100644 --- a/host/include/uhd/stream.hpp +++ b/host/include/uhd/stream.hpp @@ -217,6 +217,10 @@ public: * the call will return after a single packet has been processed. * This may be useful to maintain packet boundaries in some cases. * + * Note on threading: recv() is *not* thread-safe, to avoid locking + * overhead. The application calling recv() is responsible for making + * sure that not more than one thread can call recv() at the same time. + * * \param buffs a vector of writable memory to fill with samples * \param nsamps_per_buff the size of each buffer in number of samples * \param metadata data to fill describing the buffer |