From 2e4d78fa7a83720b22f7b5c3e3a7d0dc9db1ea0c Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Thu, 11 Jul 2013 14:13:45 -0700 Subject: [PATCH] Add DeadlineTimer member docs --- .../beast_basics/events/beast_DeadlineTimer.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Subtrees/beast/modules/beast_basics/events/beast_DeadlineTimer.h b/Subtrees/beast/modules/beast_basics/events/beast_DeadlineTimer.h index 671ab27d06..2e96c5319f 100644 --- a/Subtrees/beast/modules/beast_basics/events/beast_DeadlineTimer.h +++ b/Subtrees/beast/modules/beast_basics/events/beast_DeadlineTimer.h @@ -49,8 +49,8 @@ public: If the timer is already active, this will reset it. - @note If the timer is already active, a notification may still - occur due to concurrency. + @note If the timer is already active, the old one might go off + before this function returns. @param secondsUntilDeadline The number of seconds until the timer will send a notification. This must be @@ -62,8 +62,8 @@ public: If the timer is already active, this will reset it. - @note If the timer is already active, a notification may still - occur due to concurrency. + @note If the timer is already active, the old one might go off + before this function returns. @param secondsUntilDeadline The number of seconds until the timer will send a notification. This must be @@ -75,8 +75,8 @@ public: If the timer is already active, this will reset it. - @note If the timer is already active, a notification may still - occur due to concurrency. + @note If the timer is already active, the old one might go off + before this function returns. @note If the time is in the past, the timer will go off immediately. @@ -87,8 +87,8 @@ public: It is okay to call this on an inactive timer. - @note If the timer is already active, a notification may still - occur due to concurrency. + @note It is guaranteed that no notifications will occur after this + function returns. */ void reset ();