summaryrefslogtreecommitdiff
path: root/ace/Timer_List_T.h
diff options
context:
space:
mode:
authorschmidt <douglascraigschmidt@users.noreply.github.com>1999-08-18 02:02:27 +0000
committerschmidt <douglascraigschmidt@users.noreply.github.com>1999-08-18 02:02:27 +0000
commitf593e1cd3d92bd697776af6773e614cd404aeb32 (patch)
tree1134f3b4450a94e87c9f485fa77213ff8a1b2905 /ace/Timer_List_T.h
parent3e94ae019f94e693db519bfa4fbea86242f2bae6 (diff)
downloadATCD-f593e1cd3d92bd697776af6773e614cd404aeb32.tar.gz
ChangeLogTag:Tue Aug 17 20:02:55 1999 Douglas C. Schmidt <schmidt@tango.cs.wustl.edu>
Diffstat (limited to 'ace/Timer_List_T.h')
-rw-r--r--ace/Timer_List_T.h34
1 files changed, 18 insertions, 16 deletions
diff --git a/ace/Timer_List_T.h b/ace/Timer_List_T.h
index a8963b16d04..9caed213b8a 100644
--- a/ace/Timer_List_T.h
+++ b/ace/Timer_List_T.h
@@ -112,25 +112,27 @@ public:
const void *act,
const ACE_Time_Value &delay,
const ACE_Time_Value &interval = ACE_Time_Value::zero);
- // Schedule <type> that will expire after <delay> amount of time.
- // If it expires then <act> is passed in as the value to the
- // <functor>. If <interval> is != to <ACE_Time_Value::zero> then it
- // is used to reschedule the <type> automatically. This method
- // returns a <timer_id> that uniquely identifies the the <type>
- // entry in an internal list. This <timer_id> can be used to cancel
- // the timer before it expires. The cancellation ensures that
- // <timer_ids> are unique up to values of greater than 2 billion
- // timers. As long as timers don't stay around longer than this
- // there should be no problems with accidentally deleting the wrong
- // timer. Returns -1 on failure (which is guaranteed never to be a
- // valid <timer_id>).
+ // Schedule <type> that will expire after <delay> amount of time,
+ // which is specified in absolute time. If it expires then <act> is
+ // passed in as the value to the <functor>. If <interval> is != to
+ // <ACE_Time_Value::zero> then it is used to reschedule the <type>
+ // automatically, using relative time to the current <gettimeofday>.
+ // This method returns a <timer_id> that uniquely identifies the the
+ // <type> entry in an internal list. This <timer_id> can be used to
+ // cancel the timer before it expires. The cancellation ensures
+ // that <timer_ids> are unique up to values of greater than 2
+ // billion timers. As long as timers don't stay around longer than
+ // this there should be no problems with accidentally deleting the
+ // wrong timer. Returns -1 on failure (which is guaranteed never to
+ // be a valid <timer_id>).
virtual int reset_interval (const long timer_id,
const ACE_Time_Value &interval);
- // Resets the interval of the timer represented by <timer_id> to
- // <interval>. If <interval> is equal to <ACE_Time_Value::zero>,
- // the timer will become a non-rescheduling timer. Returns 1 if
- // successful, 0 if not.
+ // Resets the interval of the timer represented by <timer_id> to
+ // <interval>, which is specified in relative time to the current
+ // <gettimeofday>. If <interval> is equal to
+ // <ACE_Time_Value::zero>, the timer will become a non-rescheduling
+ // timer. Returns 0 if successful, -1 if not.
virtual int cancel (const TYPE &type,
int dont_call_handle_close = 1);