ACE  6.3.3
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ACE_Async_Timer_Queue_Adapter< TQ, TYPE > Class Template Reference

Adapts an ACE timer queue to be driven asynchronously using signals. More...

#include <Timer_Queue_Adapters.h>

Inheritance diagram for ACE_Async_Timer_Queue_Adapter< TQ, TYPE >:
Inheritance graph
[legend]
Collaboration diagram for ACE_Async_Timer_Queue_Adapter< TQ, TYPE >:
Collaboration graph
[legend]

Public Types

typedef TQ TIMER_QUEUE
 
- Public Types inherited from ACE_Event_Handler
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

 ACE_Async_Timer_Queue_Adapter (ACE_Sig_Set *mask=0)
 Constructor. More...
 
long schedule (TYPE type, const void *act, const ACE_Time_Value &future_time, const ACE_Time_Value &interval=ACE_Time_Value::zero)
 
int cancel (long timer_id, const void **act=0)
 
int expire (void)
 
TQ & timer_queue (void)
 Return a reference to the underlying timer queue. More...
 
- Public Member Functions inherited from ACE_Event_Handler
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 &current_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 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_Reactorreactor (void) const
 Get the event demultiplexors. More...
 
virtual ACE_Reactor_Timer_Interfacereactor_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_Policyreference_counting_policy (void)
 Current Reference_Counting_Policy. More...
 

Private Member Functions

virtual int schedule_ualarm (void)
 Perform the logic to compute the new ualarm(2) setting. More...
 
virtual int handle_signal (int signum, siginfo_t *, ucontext_t *)
 Called back by SIGALRM handler. More...
 

Private Attributes

ACE_Sig_Handler sig_handler_
 
TQ timer_queue_
 
ACE_Sig_Set mask_
 Mask of signals to be blocked when we're servicing SIGALRM. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ACE_Event_Handler
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 inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_CountAtomic_Reference_Count
 Typedef for implementation of reference counting. More...
 
- Protected Member Functions inherited from ACE_Event_Handler
 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 inherited from ACE_Event_Handler
Atomic_Reference_Count reference_count_
 Reference count. More...
 

Detailed Description

template<class TQ, class TYPE = ACE_Event_Handler*>
class ACE_Async_Timer_Queue_Adapter< TQ, TYPE >

Adapts an ACE timer queue to be driven asynchronously using signals.

This implementation uses the ACE_OS::ualarm call, to generate the SIGARLM signal that is caught by this class.

Note
This adapter only works on platforms that support ualarm(). POSIX platforms generally do; Windows and some others do not.
Todo:
This adapter does not automatically reschedule repeating timers.

Member Typedef Documentation

template<class TQ , class TYPE = ACE_Event_Handler*>
typedef TQ ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::TIMER_QUEUE

Constructor & Destructor Documentation

template<class TQ , class TYPE >
ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::ACE_Async_Timer_Queue_Adapter ( ACE_Sig_Set mask = 0)

Constructor.

Register the SIGALRM handler. If mask == 0 then block all signals when SIGALRM is run. Otherwise, just block the signals indicated in mask.

Member Function Documentation

template<class TQ , class TYPE >
int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::cancel ( long  timer_id,
const void **  act = 0 
)

Cancel the timer_id and pass back the act if an address is passed in.

template<class TQ , class TYPE >
int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::expire ( void  )

Dispatch all timers with expiry time at or before the current time. Returns the number of timers expired.

template<class TQ , class TYPE >
int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::handle_signal ( int  signum,
siginfo_t ,
ucontext_t  
)
privatevirtual

Called back by SIGALRM handler.

Reimplemented from ACE_Event_Handler.

template<class TQ , class TYPE >
long ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::schedule ( TYPE  type,
const void *  act,
const ACE_Time_Value future_time,
const ACE_Time_Value interval = ACE_Time_Value::zero 
)

Schedule the timer according to the semantics of the ACE_Timer_List. This timer gets dispatched via a signal, rather than by a user calling expire(). Note that interval timers are not implemented yet.

template<class TQ , class TYPE >
int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::schedule_ualarm ( void  )
privatevirtual

Perform the logic to compute the new ualarm(2) setting.

template<class TQ , class TYPE >
TQ & ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::timer_queue ( void  )

Return a reference to the underlying timer queue.

Member Data Documentation

template<class TQ , class TYPE = ACE_Event_Handler*>
ACE_Sig_Set ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::mask_
private

Mask of signals to be blocked when we're servicing SIGALRM.

template<class TQ , class TYPE = ACE_Event_Handler*>
ACE_Sig_Handler ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::sig_handler_
private

Handler for the SIGALRM signal, so that we can access our state without requiring any global variables.

template<class TQ , class TYPE = ACE_Event_Handler*>
TQ ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::timer_queue_
private

Implementation of the timer queue (e.g., ACE_Timer_List, ACE_Timer_Heap, etc.).


The documentation for this class was generated from the following files: