NAME

ACE_Reactor_Impl - An abstract class for implementing the Reactor Pattern.

SYNOPSIS

#include <ace/Reactor_Impl.h>

class ACE_Reactor_Impl { public: virtual ~ACE_Reactor_Impl (void) {}; virtual int open ( size_t size, int restart = 0, ACE_Sig_Handler * = 0, ACE_Timer_Queue * = 0 ) = 0; virtual int set_sig_handler (ACE_Sig_Handler *signal_handler) = 0; virtual int set_timer_queue (ACE_Timer_Queue *timer_queue) = 0; virtual int close (void) = 0; virtual int handle_events (ACE_Time_Value *max_wait_time = 0) = 0; virtual int alertable_handle_events ( ACE_Time_Value *max_wait_time = 0 ) = 0; 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 register_handler ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ) = 0; virtual int register_handler ( ACE_HANDLE io_handle, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ) = 0; virtual int register_handler ( ACE_Event_Handler *event_handler, ACE_HANDLE event_handle = ACE_INVALID_HANDLE ) = 0; virtual int register_handler ( ACE_HANDLE event_handle, ACE_HANDLE io_handle, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ) = 0; virtual int register_handler ( const ACE_Handle_Set &handles, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ) = 0; 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 ) = 0; virtual int register_handler ( const ACE_Sig_Set &sigset, ACE_Event_Handler *new_sh, ACE_Sig_Action *new_disp = 0 ) = 0; virtual int remove_handler ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask ) = 0; virtual int remove_handler ( ACE_HANDLE handle, ACE_Reactor_Mask mask ) = 0; virtual int remove_handler ( const ACE_Handle_Set &handle_set, ACE_Reactor_Mask mask ) = 0; virtual int remove_handler ( int signum, ACE_Sig_Action *new_disp, ACE_Sig_Action *old_disp = 0, int sigkey = -1 ) = 0; virtual int remove_handler (const ACE_Sig_Set &sigset) = 0; virtual int suspend_handler ( ACE_Event_Handler *event_handler ) = 0; virtual int suspend_handler (ACE_HANDLE handle) = 0; virtual int suspend_handler (const ACE_Handle_Set &handles) = 0; virtual int suspend_handlers (void) = 0; virtual int resume_handler (ACE_Event_Handler *event_handler) = 0; virtual int resume_handler (ACE_HANDLE handle) = 0; virtual int resume_handler (const ACE_Handle_Set &handles) = 0; virtual int resume_handlers (void) = 0; virtual int uses_event_associations (void) = 0; virtual long schedule_timer ( ACE_Event_Handler *event_handler, const void *arg, const ACE_Time_Value &delta, const ACE_Time_Value &interval = ACE_Time_Value::zero ) = 0; virtual int cancel_timer ( ACE_Event_Handler *event_handler, int dont_call_handle_close = 1 ) = 0; virtual int cancel_timer ( long timer_id, const void **arg = 0, int dont_call_handle_close = 1 ) = 0; virtual int schedule_wakeup ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask masks_to_be_added ) = 0; virtual int schedule_wakeup ( ACE_HANDLE handle, ACE_Reactor_Mask masks_to_be_added ) = 0; virtual int cancel_wakeup ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask masks_to_be_cleared ) = 0; virtual int cancel_wakeup ( ACE_HANDLE handle, ACE_Reactor_Mask masks_to_be_cleared ) = 0; virtual int notify ( ACE_Event_Handler *event_handler = 0, ACE_Reactor_Mask mask = ACE_Event_Handler::EXCEPT_MASK, ACE_Time_Value * = 0 ) = 0; virtual void max_notify_iterations (int) = 0; virtual int max_notify_iterations (void) = 0; virtual int handler ( ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Event_Handler **event_handler = 0 ) = 0; virtual int handler (int signum, ACE_Event_Handler ** = 0) = 0; virtual int initialized (void) = 0; virtual size_t size (void) = 0; virtual ACE_Lock &lock (void) = 0; virtual void wakeup_all_threads (void) = 0; virtual int owner ( ACE_thread_t new_owner, ACE_thread_t *old_owner = 0 ) = 0; virtual int owner (ACE_thread_t *owner) = 0; virtual void requeue_position (int) = 0; virtual int requeue_position (void) = 0; virtual int mask_ops ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask, int ops ) = 0; virtual int mask_ops ( ACE_HANDLE handle, ACE_Reactor_Mask mask, int ops ) = 0; virtual int ready_ops ( ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask, int ops ) = 0; virtual int ready_ops ( ACE_HANDLE handle, ACE_Reactor_Mask, int ops ) = 0; virtual void dump (void) const = 0; ACE_ALLOC_HOOK_DECLARE; };

Event loop drivers.

virtual int handle_events (ACE_Time_Value *max_wait_time = 0) = 0;

virtual int alertable_handle_events (
    ACE_Time_Value *max_wait_time = 0
    ) = 0;

virtual int handle_events (ACE_Time_Value &max_wait_time) = 0;

virtual int alertable_handle_events (
    ACE_Time_Value &max_wait_time
    ) = 0;

Register and remove Handlers.

virtual int register_handler (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask
    ) = 0;

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

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
    ) = 0;

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

virtual int register_handler (
    const ACE_Handle_Set &handles,
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask
    ) = 0;

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
    ) = 0;

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

virtual int remove_handler (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask
    ) = 0;

virtual int remove_handler (
    ACE_HANDLE handle,
    ACE_Reactor_Mask mask
    ) = 0;

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

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

virtual int remove_handler (const ACE_Sig_Set &sigset) = 0;

Suspend and resume Handlers.

virtual int suspend_handler (ACE_Event_Handler *event_handler) = 0;

virtual int suspend_handler (ACE_HANDLE handle) = 0;

virtual int suspend_handler (const ACE_Handle_Set &handles) = 0;

virtual int suspend_handlers (void) = 0;

virtual int resume_handler (ACE_Event_Handler *event_handler) = 0;

virtual int resume_handler (ACE_HANDLE handle) = 0;

virtual int resume_handler (const ACE_Handle_Set &handles) = 0;

virtual int resume_handlers (void) = 0;

virtual int uses_event_associations (void) = 0;

If we need to reset handles returned from accept/connect. Timer management.

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

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

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

High-level Event_Handler scheduling operations

virtual int schedule_wakeup (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask masks_to_be_added
    ) = 0;

virtual int schedule_wakeup (
    ACE_HANDLE handle,
    ACE_Reactor_Mask masks_to_be_added
    ) = 0;

virtual int cancel_wakeup (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask masks_to_be_cleared
    ) = 0;

virtual int cancel_wakeup (
    ACE_HANDLE handle,
    ACE_Reactor_Mask masks_to_be_cleared
    ) = 0;

Notification methods.

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

virtual void max_notify_iterations (int) = 0;

virtual int max_notify_iterations (void) = 0;

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

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

virtual int initialized (void) = 0;

virtual size_t size (void) = 0;

virtual ACE_Lock &lock (void) = 0;

virtual void wakeup_all_threads (void) = 0;

virtual int owner (
    ACE_thread_t new_owner,
    ACE_thread_t *old_owner = 0
    ) = 0;

virtual int owner (ACE_thread_t *owner) = 0;

virtual void requeue_position (int) = 0;

virtual int requeue_position (void) = 0;

Low-level wait_set mask manipulation methods.

virtual int mask_ops (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask,
    int ops
    ) = 0;

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

Low-level ready_set mask manipulation methods.

virtual int ready_ops (
    ACE_Event_Handler *event_handler,
    ACE_Reactor_Mask mask,
    int ops
    ) = 0;

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

virtual void dump (void) const = 0;

ACE_ALLOC_HOOK_DECLARE;

AUTHOR

Irfan Pyarali

LIBRARY

ace