NAME

ACE_Select_Reactor - An object oriented event demultiplexor and event handler dispatcher.

SYNOPSIS

#include <ace/Select_Reactor.h>

class ACE_Select_Reactor : public ACE_Reactor_Impl { public: enum{ DEFAULT_SIZE = ACE_DEFAULT_SELECT_REACTOR_SIZE }; ACE_Select_Reactor (ACE_Sig_Handler * = 0, ACE_Timer_Queue * = 0); ACE_Select_Reactor ( size_t size, int restart = 0, ACE_Sig_Handler * = 0, ACE_Timer_Queue * = 0 ); virtual int open ( size_t size = DEFAULT_SIZE, int restart = 0, ACE_Sig_Handler * = 0, ACE_Timer_Queue * = 0 ); virtual int set_sig_handler (ACE_Sig_Handler *signal_handler); virtual int set_timer_queue (ACE_Timer_Queue *timer_queue); virtual int close (void); virtual ~ACE_Select_Reactor (void); virtual int handle_events (ACE_Time_Value *max_wait_time = 0); virtual int alertable_handle_events ( ACE_Time_Value *max_wait_time = 0 ); virtual int handle_events (ACE_Time_Value &max_wait_time); virtual int alertable_handle_events ( ACE_Time_Value &max_wait_time ); virtual int register_handler ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int register_handler ( ACE_HANDLE handle, ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int register_handler ( ACE_Event_Handler *event_handler, ACE_HANDLE event_handle = ACE_INVALID_HANDLE ); virtual int register_handler ( ACE_HANDLE event_handle, ACE_HANDLE io_handle, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ); virtual int register_handler ( const ACE_Handle_Set &handles, ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int register_handler ( int signum, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0, ACE_Event_Handler **old_sh = 0, ACE_Sig_Action *old_disp = 0 ); virtual int register_handler ( const ACE_Sig_Set &sigset, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0 ); virtual int remove_handler ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int remove_handler (ACE_HANDLE handle, ACE_Reactor_Mask); virtual int remove_handler ( const ACE_Handle_Set &handle_set, ACE_Reactor_Mask ); virtual int remove_handler ( int signum, ACE_Sig_Action *new_disp, ACE_Sig_Action *old_disp = 0, int sigkey = -1 ); virtual int remove_handler (const ACE_Sig_Set &sigset); virtual int suspend_handler (ACE_Event_Handler *eh); virtual int suspend_handler (ACE_HANDLE handle); virtual int suspend_handler (const ACE_Handle_Set &handles); virtual int suspend_handlers (void); virtual int resume_handler (ACE_Event_Handler *eh); virtual int resume_handler (ACE_HANDLE handle); virtual int resume_handler (const ACE_Handle_Set &handles); virtual int resume_handlers (void); virtual int uses_event_associations (void); virtual long schedule_timer ( ACE_Event_Handler *, const void *arg, const ACE_Time_Value &delta_time, const ACE_Time_Value &interval = ACE_Time_Value::zero ); virtual int cancel_timer ( ACE_Event_Handler *event_handler, int dont_call_handle_close = 1 ); virtual int cancel_timer ( long timer_id, const void **arg = 0, int dont_call_handle_close = 1 ); virtual int schedule_wakeup ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int schedule_wakeup ( ACE_HANDLE handle, ACE_Reactor_Mask mask ); virtual int cancel_wakeup ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int cancel_wakeup ( ACE_HANDLE handle, ACE_Reactor_Mask mask ); virtual int notify ( ACE_Event_Handler * = 0, ACE_Reactor_Mask = ACE_Event_Handler::EXCEPT_MASK, ACE_Time_Value * = 0 ); virtual void requeue_position (int); virtual int requeue_position (void); virtual void max_notify_iterations (int); virtual int max_notify_iterations (void); virtual int mask_ops ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask, int ops ); virtual int mask_ops ( ACE_HANDLE handle, ACE_Reactor_Mask mask, int ops ); virtual int ready_ops ( ACE_Event_Handler *eh, ACE_Reactor_Mask mask, int ops ); virtual int ready_ops ( ACE_HANDLE handle, ACE_Reactor_Mask, int ops ); virtual void wakeup_all_threads (void); virtual int owner (ACE_thread_t n_id, ACE_thread_t *o_id = 0); virtual int owner (ACE_thread_t *); virtual int handler ( ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Event_Handler **eh = 0 ); virtual int handler (int signum, ACE_Event_Handler ** = 0); virtual int initialized (void); virtual size_t size (void); virtual ACE_Lock &lock (void); virtual void dump (void) const; ACE_ALLOC_HOOK_DECLARE; protected: virtual int register_handler_i ( ACE_HANDLE handle, ACE_Event_Handler *eh, ACE_Reactor_Mask mask ); virtual int register_handler_i ( const ACE_Handle_Set &handles, ACE_Event_Handler *handler, ACE_Reactor_Mask mask ); virtual int remove_handler_i ( ACE_HANDLE handle, ACE_Reactor_Mask ); virtual int remove_handler_i ( const ACE_Handle_Set &handles, ACE_Reactor_Mask ); virtual int suspend_i (ACE_HANDLE handle); virtual int resume_i (ACE_HANDLE handle); virtual int handler_i ( ACE_HANDLE handle, ACE_Reactor_Mask, ACE_Event_Handler ** = 0 ); virtual int handler_i (int signum, ACE_Event_Handler ** = 0); virtual int any_ready (ACE_Select_Reactor_Handle_Set &handle_set); virtual int handle_error (void); virtual int check_handles (void); virtual int bit_ops ( ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Select_Reactor_Handle_Set &wait_Set, int ops ); virtual int wait_for_multiple_events ( ACE_Select_Reactor_Handle_Set &, ACE_Time_Value * ); virtual int dispatch ( int nfound, ACE_Select_Reactor_Handle_Set & ); virtual int dispatch_timer_handlers (void); virtual int dispatch_notification_handlers ( int &number_of_active_handles, ACE_Select_Reactor_Handle_Set &dispatch_set ); virtual int dispatch_io_handlers ( int &number_of_active_handles, ACE_Select_Reactor_Handle_Set &dispatch_set ); virtual int dispatch_io_set ( int number_of_active_handles, int& number_dispatched, int mask, ACE_Handle_Set& dispatch_mask, ACE_Handle_Set& ready_mask, ACE_EH_PTMF callback ); virtual void notify_handle ( ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Handle_Set &, ACE_Event_Handler *eh, ACE_EH_PTMF callback ); ACE_Select_Reactor_Handler_Repository handler_rep_; ACE_Timer_Queue *timer_queue_; int delete_timer_queue_; ACE_Sig_Handler *signal_handler_; int delete_signal_handler_; ACE_Select_Reactor_Handle_Set wait_set_; ACE_Select_Reactor_Handle_Set suspend_set_; ACE_Select_Reactor_Handle_Set ready_set_; int restart_; int requeue_position_; int max_notify_iterations_; int initialized_; ACE_thread_t owner_; int state_changed_; ACE_Select_Reactor_Token token_; ACE_Lock_Adapter<ACE_Select_Reactor_Token> lock_adapter_; ACE_Select_Reactor_Notify notify_handler_; void renew (void); friend class ACE_Select_Reactor_Notify; friend class ACE_Select_Reactor_Handler_Repository; private: int release_token (void); int handle_events_i (ACE_Time_Value *max_wait_time = 0); ACE_Select_Reactor (const ACE_Select_Reactor &); ACE_Select_Reactor &operator = (const ACE_Select_Reactor &); };

DESCRIPTION

The ACE_Select_Reactor is an object-oriented event demultiplexor and event handler dispatcher. The sources of events that the ACE_Select_Reactor waits for and dispatches includes I/O events, signals, and timer events. All public methods acquire the main Select_Reactor token lock and call down to private or protected methods, which assume that the lock is held and so therefore don't (re)acquire the lock.

Initialization and termination methods.

ACE_Select_Reactor (ACE_Sig_Handler * = 0, ACE_Timer_Queue * = 0);

ACE_Select_Reactor (
    size_t size,
    int restart = 0,
    ACE_Sig_Handler * = 0,
    ACE_Timer_Queue * = 0
    );

virtual int open (
    size_t size = DEFAULT_SIZE,
    int restart = 0,
    ACE_Sig_Handler * = 0,
    ACE_Timer_Queue * = 0
    );

virtual int set_sig_handler (ACE_Sig_Handler *signal_handler);

virtual int set_timer_queue (ACE_Timer_Queue *timer_queue);

virtual int close (void);

virtual ~ACE_Select_Reactor (void);

Event loop drivers.

virtual int handle_events (ACE_Time_Value *max_wait_time = 0);

virtual int alertable_handle_events (
    ACE_Time_Value *max_wait_time = 0
    );

virtual int handle_events (ACE_Time_Value &max_wait_time);

virtual int alertable_handle_events (ACE_Time_Value &max_wait_time);

= Register and remove ACE_Event_Handlers.

virtual int register_handler (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int register_handler (
    ACE_HANDLE handle,
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

Originally this interface was available for all platforms, but because ACE_HANDLE is an int on non-Win32 platforms, compilers are not able to tell the difference between register_handler(ACE_Event_Handler*,ACE_Reactor_Mask) and register_handler(ACE_Event_Handler*,ACE_HANDLE). Therefore, we have restricted this method to Win32 only.

virtual int register_handler (
    ACE_Event_Handler *event_handler,
    ACE_HANDLE event_handle = ACE_INVALID_HANDLE
    );

virtual int register_handler (
    ACE_HANDLE event_handle,
    ACE_HANDLE io_handle,
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask
    );

virtual int register_handler (
    const ACE_Handle_Set &handles,
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int register_handler (
    int signum,
    ACE_Event_Handler *new_sh,
    ACE_Sig_Action *new_disp = 0,
    ACE_Event_Handler **old_sh = 0,
    ACE_Sig_Action *old_disp = 0
    );

virtual int register_handler (
    const ACE_Sig_Set &sigset,
    ACE_Event_Handler *new_sh,
    ACE_Sig_Action *new_disp = 0
    );

virtual int remove_handler (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int remove_handler (ACE_HANDLE handle, ACE_Reactor_Mask);

virtual int remove_handler (
    const ACE_Handle_Set &handle_set,
    ACE_Reactor_Mask
    );

virtual int remove_handler (
    int signum,
    ACE_Sig_Action *new_disp,
    ACE_Sig_Action *old_disp = 0,
    int sigkey = -1
    );

virtual int remove_handler (const ACE_Sig_Set &sigset);

Suspend and resume Handlers.

virtual int suspend_handler (ACE_Event_Handler *eh);

virtual int suspend_handler (ACE_HANDLE handle);

virtual int suspend_handler (const ACE_Handle_Set &handles);

virtual int suspend_handlers (void);

virtual int resume_handler (ACE_Event_Handler *eh);

virtual int resume_handler (ACE_HANDLE handle);

virtual int resume_handler (const ACE_Handle_Set &handles);

virtual int resume_handlers (void);

virtual int uses_event_associations (void);

Timer management.

virtual long schedule_timer (
    ACE_Event_Handler *,
    const void *arg,
    const ACE_Time_Value &delta_time,
    const ACE_Time_Value &interval = ACE_Time_Value::zero
    );

virtual int cancel_timer (
    ACE_Event_Handler *event_handler,
    int dont_call_handle_close = 1
    );

virtual int cancel_timer (
    long timer_id,
    const void **arg = 0,
    int dont_call_handle_close = 1
    );

High-level Event_Handler scheduling operations

virtual int schedule_wakeup (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int schedule_wakeup (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask
    );

virtual int cancel_wakeup (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int cancel_wakeup (ACE_HANDLE handle, ACE_Reactor_Mask mask);

Notification methods.

virtual int notify (
    ACE_Event_Handler * = 0,
    ACE_Reactor_Mask = ACE_Event_Handler::EXCEPT_MASK,
    ACE_Time_Value * = 0
    );

virtual void requeue_position (int);

virtual int requeue_position (void);

virtual void max_notify_iterations (int);

virtual int max_notify_iterations (void);

Low-level wait_set mask manipulation methods.

virtual int mask_ops (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask,
    int ops
    );

virtual int mask_ops (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask,
    int ops
    );

Low-level ready_set mask manipulation methods.

virtual int ready_ops (
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask,
    int ops
    );

virtual int ready_ops (ACE_HANDLE handle, ACE_Reactor_Mask, int ops);

virtual void wakeup_all_threads (void);

= Only the owner thread that can perform a handle_events.

virtual int owner (ACE_thread_t n_id, ACE_thread_t *o_id = 0);

virtual int owner (ACE_thread_t *);

Miscellaneous Handler operations.

virtual int handler (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask,
    ACE_Event_Handler **eh = 0
    );

virtual int handler (int signum, ACE_Event_Handler ** = 0);

virtual int initialized (void);

virtual size_t size (void);

virtual ACE_Lock &lock (void);

virtual void dump (void) const;

ACE_ALLOC_HOOK_DECLARE;

Internal methods that do the actual work.

All of these methods assume that the Select_Reactor's token lock is held by the public methods that call down to them.
virtual int register_handler_i (
    ACE_HANDLE handle,
    ACE_Event_Handler *eh,
    ACE_Reactor_Mask mask
    );

virtual int register_handler_i (
    const ACE_Handle_Set &handles,
    ACE_Event_Handler *handler,
    ACE_Reactor_Mask mask
    );

virtual int remove_handler_i (ACE_HANDLE handle, ACE_Reactor_Mask);

virtual int remove_handler_i (
    const ACE_Handle_Set &handles,
    ACE_Reactor_Mask
    );

virtual int suspend_i (ACE_HANDLE handle);

virtual int resume_i (ACE_HANDLE handle);

virtual int handler_i (
    ACE_HANDLE handle,
    ACE_Reactor_Mask,
    ACE_Event_Handler ** = 0
    );

virtual int handler_i (int signum, ACE_Event_Handler ** = 0);

virtual int any_ready (ACE_Select_Reactor_Handle_Set &handle_set);

virtual int handle_error (void);

virtual int check_handles (void);

virtual int bit_ops (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask,
    ACE_Select_Reactor_Handle_Set &wait_Set,
    int ops
    );

virtual int wait_for_multiple_events (
    ACE_Select_Reactor_Handle_Set &,
    ACE_Time_Value *
    );

Dispatching methods.

virtual int dispatch (int nfound, ACE_Select_Reactor_Handle_Set &);

virtual int dispatch_timer_handlers (void);

virtual int dispatch_notification_handlers (
    int &number_of_active_handles,
    ACE_Select_Reactor_Handle_Set &dispatch_set
    );

virtual int dispatch_io_handlers (
    int &number_of_active_handles,
    ACE_Select_Reactor_Handle_Set &dispatch_set
    );

virtual int dispatch_io_set (
    int number_of_active_handles,
    int& number_dispatched,
    int mask,
    ACE_Handle_Set& dispatch_mask,
    ACE_Handle_Set& ready_mask,
    ACE_EH_PTMF callback
    );

virtual void notify_handle (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask,
    ACE_Handle_Set &,
    ACE_Event_Handler *eh,
    ACE_EH_PTMF callback
    );

ACE_Select_Reactor_Handler_Repository handler_rep_;

ACE_Timer_Queue *timer_queue_;

int delete_timer_queue_;

ACE_Sig_Handler *signal_handler_;

int delete_signal_handler_;

ACE_Select_Reactor_Handle_Set wait_set_;

ACE_Select_Reactor_Handle_Set suspend_set_;

ACE_Select_Reactor_Handle_Set ready_set_;

int restart_;

int requeue_position_;

int max_notify_iterations_;

int initialized_;

ACE_thread_t owner_;

int state_changed_;

ACE_Select_Reactor_Token token_;

ACE_Lock_Adapter<ACE_Select_Reactor_Token> lock_adapter_;

ACE_Select_Reactor_Notify notify_handler_;

void renew (void);

friend class ACE_Select_Reactor_Notify;

friend class ACE_Select_Reactor_Handler_Repository;

AUTHOR

Doug Schmidt

LIBRARY

ace