From 62c1b02eb1bdcbc29620cfe07022401b9b70ebcb Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Mon, 29 Jul 2013 14:00:45 -0700 Subject: [PATCH] Clarify behavior of pauseAllThreadsAndWait --- modules/beast_basics/threads/beast_Workers.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/modules/beast_basics/threads/beast_Workers.h b/modules/beast_basics/threads/beast_Workers.h index 22e72bb81..4d2d9e9a9 100644 --- a/modules/beast_basics/threads/beast_Workers.h +++ b/modules/beast_basics/threads/beast_Workers.h @@ -58,7 +58,12 @@ public: */ void setNumberOfThreads (int numberOfThreads); - /** Pause and wait for all threads. + /** Pause all threads and wait until they are paused. + + If a thread is processing a task it will pause as soon as the task + completes. There may still be tasks signaled even after all threads + have paused. + @note This function is not thread-safe. */ void pauseAllThreadsAndWait ();