aboutsummaryrefslogtreecommitdiff
path: root/src/stable/thread.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/stable/thread.h')
-rw-r--r--src/stable/thread.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/stable/thread.h b/src/stable/thread.h
index 294c250..5174d1c 100644
--- a/src/stable/thread.h
+++ b/src/stable/thread.h
@@ -79,11 +79,16 @@ namespace Bu
79 * probably create a memory leak type of situation. Instead of stop, 79 * probably create a memory leak type of situation. Instead of stop,
80 * consider using cancel, which can be handled by the running thread in 80 * consider using cancel, which can be handled by the running thread in
81 * a graceful manner. 81 * a graceful manner.
82 *
83 * NOTE: This was called stop(), but that was too ambiguous and common
84 * of a name to implement in subclasses. The functionality was not
85 * obvious, and this was sometimes used in place of a clean stopping
86 * routine.
82 *@returns True if the thread was stopped, false otherwise. When this 87 *@returns True if the thread was stopped, false otherwise. When this
83 * function returns the thread may not have stopped, to ensure that the 88 * function returns the thread may not have stopped, to ensure that the
84 * thread has really stopped, call join. 89 * thread has really stopped, call join.
85 */ 90 */
86 bool stop(); 91 bool forceStop();
87 92
88 /** 93 /**
89 * Join the thread in action. This function performs what is commonly 94 * Join the thread in action. This function performs what is commonly