ACE
6.1.8
|
Provides an abstract interface for handling various types of I/O, timer, and signal events. More...
#include <Event_Handler.h>
Classes | |
class | Policy |
Base class for all handler policies. More... | |
class | Reference_Counting_Policy |
This policy dictates the reference counting requirements for the handler. More... | |
Public Types | |
enum | { LO_PRIORITY = 0, HI_PRIORITY = 10, NULL_MASK = 0, READ_MASK = (1 << 0), WRITE_MASK = (1 << 1), EXCEPT_MASK = (1 << 2), ACCEPT_MASK = (1 << 3), CONNECT_MASK = (1 << 4), TIMER_MASK = (1 << 5), QOS_MASK = (1 << 6), GROUP_QOS_MASK = (1 << 7), SIGNAL_MASK = (1 << 8), ALL_EVENTS_MASK, RWE_MASK, DONT_CALL = (1 << 9) } |
enum | { ACE_EVENT_HANDLER_NOT_RESUMED = -1, ACE_REACTOR_RESUMES_HANDLER = 0, ACE_APPLICATION_RESUMES_HANDLER } |
typedef long | Reference_Count |
Reference count type. More... | |
Public Member Functions | |
virtual | ~ACE_Event_Handler (void) |
Destructor is virtual to enable proper cleanup. More... | |
virtual ACE_HANDLE | get_handle (void) const |
Get the I/O handle. More... | |
virtual void | set_handle (ACE_HANDLE) |
Set the I/O handle. More... | |
virtual int | priority (void) const |
virtual void | priority (int priority) |
Set the priority of the Event_Handler. More... | |
virtual int | handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE) |
Called when input events occur (e.g., connection or data). More... | |
virtual int | handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE) |
virtual int | handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE) |
Called when an exceptional events occur (e.g., SIGURG). More... | |
virtual int | handle_timeout (const ACE_Time_Value ¤t_time, const void *act=0) |
virtual int | handle_exit (ACE_Process *) |
Called when a process exits. More... | |
virtual int | handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask) |
virtual int | handle_signal (int signum, siginfo_t *=0, ucontext_t *=0) |
virtual int | resume_handler (void) |
virtual int | handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE) |
virtual int | handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE) |
virtual void | reactor (ACE_Reactor *reactor) |
Set the event demultiplexors. More... | |
virtual ACE_Reactor * | reactor (void) const |
Get the event demultiplexors. More... | |
virtual ACE_Reactor_Timer_Interface * | reactor_timer_interface (void) const |
Get only the reactor's timer related interface. More... | |
virtual Reference_Count | add_reference (void) |
Increment reference count on the handler. More... | |
virtual Reference_Count | remove_reference (void) |
Decrement reference count on the handler. More... | |
Reference_Counting_Policy & | reference_counting_policy (void) |
Current Reference_Counting_Policy. More... | |
Static Public Member Functions | |
static ACE_THR_FUNC_RETURN | read_adapter (void *event_handler) |
static int | register_stdin_handler (ACE_Event_Handler *eh, ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED) |
static int | remove_stdin_handler (ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr) |
Performs the inverse of the register_stdin_handler() method. More... | |
Protected Types | |
typedef ACE_Atomic_Op < ACE_SYNCH_MUTEX, Reference_Count > | Atomic_Reference_Count |
Typedef for implementation of reference counting. More... | |
Protected Member Functions | |
ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY) | |
Force ACE_Event_Handler to be an abstract base class. More... | |
Protected Attributes | |
Atomic_Reference_Count | reference_count_ |
Reference count. More... | |
Private Attributes | |
int | priority_ |
Priority of this Event_Handler. More... | |
ACE_Reactor * | reactor_ |
Pointer to the various event demultiplexors. More... | |
Reference_Counting_Policy | reference_counting_policy_ |
Reference counting requirements. More... | |
Provides an abstract interface for handling various types of I/O, timer, and signal events.
Subclasses read/write input/output on an I/O descriptor, handle an exception raised on an I/O descriptor, handle a timer's expiration, or handle a signal.
|
protected |
Typedef for implementation of reference counting.
typedef long ACE_Event_Handler::Reference_Count |
Reference count type.
anonymous enum |
anonymous enum |
|
virtual |
Destructor is virtual to enable proper cleanup.
|
protected |
Force ACE_Event_Handler to be an abstract base class.
|
virtual |
Increment reference count on the handler.
This method is called when the handler is registered with the Reactor and when the Reactor makes an upcall on the handler. Reference count is 1 when the handler is created.
|
virtual |
Get the I/O handle.
Reimplemented in ACE_POSIX_Asynch_Connect, ACE_POSIX_Asynch_Accept, ACE_Oneshot_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_WFMO_Reactor_Notify, ACE_Strategy_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_2 >, ACE_POSIX_Proactor, ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >, ACE_Svc_Handler< ACE_PEER_STREAM_2, ACE_SYNCH_USE >, ACE_WIN32_Proactor, ACE_Event_Handler_T< T >, ACE_Service_Manager, ACE_Proactor_Impl, and ACE_Name_Proxy.
|
virtual |
Called when a handle_*() method returns -1 or when the remove_handler() method is called on an ACE_Reactor. The close_mask indicates which event has triggered the handle_close() method callback on a particular handle.
Reimplemented in ACE_POSIX_Asynch_Connect, ACE_POSIX_Asynch_Accept, ACE_Oneshot_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Strategy_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_WIN32_Proactor, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_2 >, ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >, ACE_Svc_Handler< ACE_PEER_STREAM_2, ACE_SYNCH_USE >, ACE_Logging_Strategy, ACE_Event_Handler_T< T >, ACE_NonBlocking_Connect_Handler< SVC_HANDLER >, and ACE_Service_Manager.
|
virtual |
Called when an exceptional events occur (e.g., SIGURG).
Reimplemented in ACE_NonBlocking_Connect_Handler< SVC_HANDLER >, and ACE_Event_Handler_T< T >.
|
virtual |
Called when a process exits.
|
virtual |
|
virtual |
Called when input events occur (e.g., connection or data).
Reimplemented in ACE_POSIX_Asynch_Accept, ACE_Oneshot_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_2 >, ACE_Select_Reactor_Notify, ACE_Dev_Poll_Reactor_Notify, ACE_NonBlocking_Connect_Handler< SVC_HANDLER >, ACE_Event_Handler_T< T >, and ACE_Service_Manager.
|
virtual |
Called when output events are possible (e.g., when flow control abates or non-blocking connection completes).
Reimplemented in ACE_POSIX_Asynch_Connect, ACE_NonBlocking_Connect_Handler< SVC_HANDLER >, and ACE_Event_Handler_T< T >.
|
virtual |
|
virtual |
Called when object is signaled by OS (either via UNIX signals or when a Win32 object becomes signaled).
Reimplemented in ACE_WFMO_Reactor_Notify, ACE_Strategy_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Process_Manager, ACE_WIN32_Proactor, ACE_Shared_Memory_Pool, ACE_Event_Handler_T< T >, ACE_Service_Manager, ACE_Async_Timer_Queue_Adapter< TQ, TYPE >, ACE_Wakeup_All_Threads_Handler, ACE_Test_and_Set< ACE_LOCK, TYPE >, and ACE_Sig_Adapter.
|
virtual |
Called when timer expires. current_time represents the current time that the Event_Handler was selected for timeout dispatching and act is the asynchronous completion token that was passed in when <schedule_timer> was invoked.
Reimplemented in ACE_Oneshot_Acceptor< SVC_HANDLER, ACE_PEER_ACCEPTOR_1 >, ACE_Buffered_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >, ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >, ACE_Svc_Handler< ACE_PEER_STREAM_2, ACE_SYNCH_USE >, ACE_NonBlocking_Connect_Handler< SVC_HANDLER >, ACE_Event_Handler_T< T >, ACE_Logging_Strategy, and ACE::Monitor_Control::Monitor_Point_Auto_Updater.
|
virtual |
Get the priority of the Event_Handler.
|
virtual |
Set the priority of the Event_Handler.
|
virtual |
Set the event demultiplexors.
Reimplemented in ACE_Connector< SVC_HANDLER, ACE_PEER_CONNECTOR_1 >, ACE_Connector< SVC_HANDLER, ACE_PEER_CONNECTOR_2 >, and ACE_Logging_Strategy.
|
virtual |
Get the event demultiplexors.
Reimplemented in ACE_Connector< SVC_HANDLER, ACE_PEER_CONNECTOR_1 >, ACE_Connector< SVC_HANDLER, ACE_PEER_CONNECTOR_2 >, and ACE_Logging_Strategy.
|
virtual |
Get only the reactor's timer related interface.
|
static |
Used to read from non-socket ACE_HANDLEs in our own thread to work around Win32 limitations that don't allow us to <select> on non-sockets (such as ACE_STDIN). This is commonly used in situations where the Reactor is used to demultiplex read events on ACE_STDIN on UNIX. Note that event_handler must be a subclass of ACE_Event_Handler. If the get_handle() method of this event handler returns ACE_INVALID_HANDLE we default to reading from ACE_STDIN.
ACE_Event_Handler::Reference_Counting_Policy & ACE_Event_Handler::reference_counting_policy | ( | void | ) |
Current Reference_Counting_Policy.
|
static |
Abstracts away from the differences between Win32 and ACE with respect to reading from ACE_STDIN, which is non-<select>'able on Win32.
|
virtual |
Decrement reference count on the handler.
This method is called when the handler is removed from the Reactor and when an upcall made on the handler by the Reactor completes. Handler is deleted when the reference count reaches 0.
|
static |
Performs the inverse of the register_stdin_handler() method.
|
virtual |
Called to figure out whether the handler needs to resumed by the reactor or the application can take care of it. The default value of 0 would be returned which would allow the reactor to take care of resumption of the handler. The application can return a value more than zero and decide to resume the handler themselves.
Reimplemented in ACE_NonBlocking_Connect_Handler< SVC_HANDLER >.
|
virtual |
Set the I/O handle.
Reimplemented in ACE_POSIX_Asynch_Connect, ACE_POSIX_Asynch_Accept, ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >, ACE_Svc_Handler< ACE_PEER_STREAM_2, ACE_SYNCH_USE >, and ACE_Event_Handler_T< T >.
|
private |
Priority of this Event_Handler.
|
private |
Pointer to the various event demultiplexors.
|
protected |
Reference count.
|
private |
Reference counting requirements.