ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add DeadlineTimer member docs

Browse Source
This commit is contained in:
Vinnie Falco
2013-07-11 14:13:45 -07:00
parent 58f2bbde53
commit 2e4d78fa7a
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Subtrees/beast/modules/beast_basics/events/beast_DeadlineTimer.h
View File

@@ -49,8 +49,8 @@ public:
If the timer is already active, this will reset it. If the timer is already active, this will reset it.
@note If the timer is already active, a notification may still @note If the timer is already active, the old one might go off
occur due to concurrency. before this function returns.
@param secondsUntilDeadline The number of seconds until the timer @param secondsUntilDeadline The number of seconds until the timer
will send a notification. This must be will send a notification. This must be
@@ -62,8 +62,8 @@ public:
If the timer is already active, this will reset it. If the timer is already active, this will reset it.
@note If the timer is already active, a notification may still @note If the timer is already active, the old one might go off
occur due to concurrency. before this function returns.
@param secondsUntilDeadline The number of seconds until the timer @param secondsUntilDeadline The number of seconds until the timer
will send a notification. This must be will send a notification. This must be
@@ -75,8 +75,8 @@ public:
If the timer is already active, this will reset it. If the timer is already active, this will reset it.
@note If the timer is already active, a notification may still @note If the timer is already active, the old one might go off
occur due to concurrency. before this function returns.
@note If the time is in the past, the timer will go off @note If the time is in the past, the timer will go off
immediately. immediately.
@@ -87,8 +87,8 @@ public:
It is okay to call this on an inactive timer. It is okay to call this on an inactive timer.
@note If the timer is already active, a notification may still @note It is guaranteed that no notifications will occur after this
occur due to concurrency. function returns.
*/ */
void reset (); void reset ();