clap

commit 9f40eafdfeaec323c035fa8cdd2104b5c5ce0a15
parent 663dd39135195629e2bc99087591828a0ec09729
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date:   Fri, 24 Sep 2021 12:16:38 +0200

Add a real-time concern/warning to the thread-pool interface

Diffstat:
M
include/clap/ext/draft/thread-pool.h
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/include/clap/ext/draft/thread-pool.h b/include/clap/ext/draft/thread-pool.h
@@ -31,6 +31,12 @@
 ///    ...
 /// }
 /// @endcode
+///
+/// Be aware that using a thread pool may break hard real-time rules due to the thread
+/// synchronization involved.
+///
+/// If the host knows that it is running under hard real-time pressure it may decide to not
+/// provide this interface.
 
 static CLAP_CONSTEXPR const char CLAP_EXT_THREAD_POOL[] = "clap.thread-pool.draft/0";