From d6640a64bdc17f185001ea93caf6bc8b3b6a01be Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Fri, 23 Sep 2016 18:10:16 -0700 Subject: stream: Document thread-non-safety of recv() --- host/include/uhd/stream.hpp | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'host/include') 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 -- cgit v1.2.3