summaryrefslogtreecommitdiff
path: root/ace/ReactorEx.h
diff options
context:
space:
mode:
authorschmidt <douglascraigschmidt@users.noreply.github.com>1997-01-13 04:40:43 +0000
committerschmidt <douglascraigschmidt@users.noreply.github.com>1997-01-13 04:40:43 +0000
commita35ae2f983e79aa3e58c30c46850fbed8db04146 (patch)
tree09f268a4fc7b6fde778abdc2654d049ec6286fc2 /ace/ReactorEx.h
parentac28159e4d1b086ead532421d73eaba695a9ea7b (diff)
downloadATCD-a35ae2f983e79aa3e58c30c46850fbed8db04146.tar.gz
foo
Diffstat (limited to 'ace/ReactorEx.h')
-rw-r--r--ace/ReactorEx.h28
1 files changed, 16 insertions, 12 deletions
diff --git a/ace/ReactorEx.h b/ace/ReactorEx.h
index 6b04f1eaf1a..9aacce36118 100644
--- a/ace/ReactorEx.h
+++ b/ace/ReactorEx.h
@@ -305,21 +305,23 @@ public:
const void *arg,
const ACE_Time_Value &delta,
const ACE_Time_Value &interval = ACE_Time_Value::zero);
- // Schedule an Event Handler <eh> that will expire after <delta>
- // amount of time. If it expires then <arg> is passed in as the
- // value to <handle_timeout> method call on <eh>. If <interval> is
- // != to ACE_Time_Value::zero then it is used to reschedule <eh>
- // automatically. This method returns a timer handle that uniquely
- // identifies the <eh> in an internal list. This timer handle can
- // be used to cancel an Event_Handler 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.
+ // Schedule an <event_handler> that will expire after <delay> amount
+ // of time. If it expires then <arg> is passed in as the value to
+ // the <event_handler>'s <handle_timeout> callback method. If
+ // <interval> is != to <ACE_Time_Value::zero> then it is used to
+ // reschedule the <event_handler> automatically. This method
+ // returns a <timer_id> that uniquely identifies the <event_handler>
+ // in an internal list. This <timer_id> can be used to cancel an
+ // <event_handler> 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 cancel_timer (ACE_Event_Handler *event_handler);
// Cancel all Event_Handlers that match the address of
- // <event_handler>.
+ // <event_handler>. Returns number of handler's cancelled.
virtual int cancel_timer (int timer_id, const void **arg = 0);
// Cancel the single Event_Handler that matches the <timer_id> value
@@ -327,6 +329,8 @@ public:
// non-NULL then it will be set to point to the ``magic cookie''
// argument passed in when the Event_Handler was registered. This
// makes it possible to free up the memory and avoid memory leaks.
+ // Returns 1 if cancellation succeeded and 0 if the <timer_id>
+ // wasn't found.
// = Notification methods.