diff options
Diffstat (limited to 'ACE/ace/Reactor.h')
| -rw-r--r-- | ACE/ace/Reactor.h | 90 |
1 files changed, 48 insertions, 42 deletions
diff --git a/ACE/ace/Reactor.h b/ACE/ace/Reactor.h index a791a65227d..2211d817f81 100644 --- a/ACE/ace/Reactor.h +++ b/ACE/ace/Reactor.h @@ -43,7 +43,7 @@ class ACE_Sig_Set; /* * Hook to specialize the Reactor implementation with the concrete - * Reactor type, for exmaple, select, thread pool reactor known + * Reactor type, for example, select, thread pool reactor known * at compile time. */ //@@ REACTOR_SPL_INCLUDE_FORWARD_DECL_ADD_HOOK @@ -107,14 +107,14 @@ public: // = Singleton reactor event loop management methods. // Note that these method ONLY work on the "Singleton Reactor," - // i.e., the one returned from <ACE_Reactor::instance>. + // i.e., the one returned from ACE_Reactor::instance(). /** * Run the event loop until the - * <ACE_Reactor::handle_events/ACE_Reactor::alertable_handle_events> - * method returns -1 or the <end_event_loop> method is invoked. + * ACE_Reactor::handle_events()/ACE_Reactor::alertable_handle_events() + * method returns -1 or the end_event_loop() method is invoked. * Note that this method can only be used by the singleton - * <ACE_Reactor::instance>. Thus, to run another reactor use - * <ACE_Reactor::run_reactor_event_loop>. + * ACE_Reactor::instance(). Thus, to run another reactor use + * ACE_Reactor::run_reactor_event_loop(). * * @deprecated Use ACE_Reactor::instance()->run_reactor_event_loop() instead */ @@ -122,11 +122,11 @@ public: static int run_alertable_event_loop (void); /** - * Run the event loop until the <ACE_Reactor::handle_events> or + * Run the event loop until the ACE_Reactor::handle_events() or * <ACE_Reactor::alertable_handle_events> methods returns -1, the - * <end_event_loop> method is invoked, or the ACE_Time_Value + * end_event_loop() method is invoked, or the ACE_Time_Value * expires. Note that this method can only be used by the singleton - * <ACE_Reactor::instance>. Thus, to run another reactor use + * ACE_Reactor::instance(). Thus, to run another reactor use * <ACE_Reactor::run_reactor_event_loop>. * * @deprecated Use ACE_Reactor::instance()->run_reactor_event_loop() instead @@ -135,10 +135,10 @@ public: static int run_alertable_event_loop (ACE_Time_Value &tv); /** - * Instruct the <ACE_Reactor::instance> to terminate its event loop - * and notifies the <ACE_Reactor::instance> so that it can wake up + * Instruct the ACE_Reactor::instance() to terminate its event loop + * and notifies the ACE_Reactor::instance() so that it can wake up * and close down gracefully. Note that this method can only be - * used by the singleton <ACE_Reactor::instance>. Thus, to + * used by the singleton ACE_Reactor::instance(). Thus, to * terminate another reactor, use * <ACE_Reactor::end_reactor_event_loop>. * @@ -147,9 +147,9 @@ public: static int end_event_loop (void); /** - * Report if the <ACE_Reactor::instance>'s event loop is finished. + * Report if the ACE_Reactor::instance()'s event loop is finished. * Note that this method can only be used by the singleton - * <ACE_Reactor::instance>. Thus, to check another reactor use + * ACE_Reactor::instance(). Thus, to check another reactor use * <ACE_Reactor::reactor_event_loop_done>. * * @deprecated Use ACE_Reactor::instance()->reactor_event_loop_done() instead @@ -157,10 +157,10 @@ public: static int event_loop_done (void); /** - * Resets the <ACE_Reactor::end_event_loop_> static so that the - * <run_event_loop> method can be restarted. Note that this method - * can only be used by the singleton <ACE_Reactor::instance>. Thus, - * to reset another reactor use <ACE_Reactor::reset_reactor_event_loop>. + * Resets the ACE_Reactor::end_event_loop_ static so that the + * run_event_loop() method can be restarted. Note that this method + * can only be used by the singleton ACE_Reactor::instance(). Thus, + * to reset another reactor use ACE_Reactor::reset_reactor_event_loop(). * * @deprecated Use ACE_Reactor::instance()->reset_reactor_event_loop() * instead @@ -179,16 +179,16 @@ public: // These methods work with an instance of a reactor. /** * Run the event loop until the - * <ACE_Reactor::handle_events/ACE_Reactor::alertable_handle_events> - * method returns -1 or the <end_reactor_event_loop> method is invoked. + * ACE_Reactor::handle_events()/ACE_Reactor::alertable_handle_events() + * method returns -1 or the end_reactor_event_loop() method is invoked. */ int run_reactor_event_loop (REACTOR_EVENT_HOOK = 0); int run_alertable_reactor_event_loop (REACTOR_EVENT_HOOK = 0); /** - * Run the event loop until the <ACE_Reactor::handle_events> or + * Run the event loop until the ACE_Reactor::handle_events() or * <ACE_Reactor::alertable_handle_events> methods returns -1, the - * <end_reactor_event_loop> method is invoked, or the ACE_Time_Value + * end_reactor_event_loop() method is invoked, or the ACE_Time_Value * expires. */ int run_reactor_event_loop (ACE_Time_Value &tv, @@ -212,8 +212,8 @@ public: /// Indicate if the Reactor's event loop has been ended. int reactor_event_loop_done (void); - /// Resets the <ACE_Reactor::end_event_loop_> static so that the - /// <run_event_loop> method can be restarted. + /// Resets the ACE_Reactor::end_event_loop_ static so that the + /// run_event_loop() method can be restarted. void reset_reactor_event_loop (void); /** @@ -232,9 +232,9 @@ public: virtual ~ACE_Reactor (void); /** - * Initialize the ACE_Reactor to manage <max_number_of_handles>. - * If @a restart is false then the ACE_Reactor's <handle_events> - * method will be restarted automatically when <EINTR> occurs. If + * Initialize the ACE_Reactor to manage @a max_number_of_handles. + * If @a restart is false then the ACE_Reactor's handle_events() + * method will be restarted automatically when @c EINTR occurs. If * @a signal_handler or @a timer_queue are non-0 they are used as the * signal handler and timer queue, respectively. */ @@ -281,8 +281,8 @@ public: * that were dispatched, 0 if the @a max_wait_time elapsed without * dispatching any handlers, or -1 if an error occurs. * - * The only difference between <alertable_handle_events> and - * <handle_events> is that in the alertable case, the eventloop will + * The only difference between alertable_handle_events() and + * handle_events() is that in the alertable case, the eventloop will * return when the system queues an I/O completion routine or an * Asynchronous Procedure Call. */ @@ -294,8 +294,8 @@ public: * @a max_wait_time value is a reference and can therefore never be * NULL. * - * The only difference between <alertable_handle_events> and - * <handle_events> is that in the alertable case, the eventloop will + * The only difference between alertable_handle_events() and + * handle_events() is that in the alertable case, the eventloop will * return when the system queues an I/O completion routine or an * Asynchronous Procedure Call. */ @@ -544,7 +544,7 @@ public: /** * Schedule a timer event. * - * Schedule a timer event that will expire after an <delay> amount + * Schedule a timer event that will expire after an @a delay amount * of time. The return value of this method, a timer_id value, * uniquely identifies the @a event_handler in the ACE_Reactor's * internal list of timers. This timer_id value can be used to @@ -559,13 +559,19 @@ public: * @see cancel_timer() * @see reset_timer_interval() * - * @param event_handler Event handler to schedule on reactor - * @param arg Argument passed to the handle_timeout() method of - * event_handler - * @param delay Time interval after which the timer will expire - * @param interval Time interval after which the timer will be automatically - * rescheduled - * @return -1 on failure, a timer_id value on success + * @param event_handler Event handler to schedule on reactor. The handler's + * handle_timeout() method will be called when this + * scheduled timer expires. + * @param arg Argument passed to the handle_timeout() method of + * event_handler. + * @param delay Time interval after which the timer will expire. + * @param interval Time interval for which the timer will be + * automatically rescheduled if the handle_timeout() + * callback does not return a value less than 0. + * + * @retval timer id, on success. The id can be used to + * cancel or reschedule this timer. + * @retval -1 on failure, with errno set. */ virtual long schedule_timer (ACE_Event_Handler *event_handler, const void *arg, @@ -578,7 +584,7 @@ public: * * Resets the interval of the timer represented by @a timer_id to * @a interval, which is specified in relative time to the current - * <gettimeofday>. If @a interval is equal to + * gettimeofday(). If @a interval is equal to * ACE_Time_Value::zero, the timer will become a non-rescheduling * timer. Returns 0 if successful, -1 if not. * @@ -703,7 +709,7 @@ public: * Set the maximum number of times that ACE_Reactor will * iterate and dispatch the ACE_Event_Handlers that are passed in * via the notify queue before breaking out of its - * <ACE_Message_Queue::dequeue> loop. By default, this is set to + * ACE_Message_Queue::dequeue() loop. By default, this is set to * -1, which means "iterate until the queue is empty." Setting this * to a value like "1 or 2" will increase "fairness" (and thus * prevent starvation) at the expense of slightly higher dispatching @@ -715,7 +721,7 @@ public: * Get the maximum number of times that the ACE_Reactor will * iterate and dispatch the ACE_Event_Handler's that are passed in * via the notify queue before breaking out of its - * <ACE_Message_Queue::dequeue> loop. + * ACE_Message_Queue::dequeue() loop. */ int max_notify_iterations (void); |