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 >:

Collaboration diagram for ACE_Async_Timer_Queue_Adapter< TQ, TYPE >:

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.

Public Member Functions
	ACE_Async_Timer_Queue_Adapter (ACE_Sig_Set *mask=0)
	Constructor.
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 ()
TQ &	timer_queue ()
	Return a reference to the underlying timer queue.
Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler ()=default
	Destructor is virtual to enable proper cleanup.
virtual ACE_HANDLE	get_handle () const
	Get the I/O handle.
virtual void	set_handle (ACE_HANDLE)
	Set the I/O handle.
virtual int	priority () const
virtual void	priority (int priority)
	Set the priority of the Event_Handler.
virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when input events occur (e.g., connection or data).
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).
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.
virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)
virtual int	resume_handler ()
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.
virtual ACE_Reactor *	reactor () const
	Get the event demultiplexors.
virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface () const
	Get only the reactor's timer related interface.
virtual Reference_Count	add_reference ()
	Increment reference count on the handler.
virtual Reference_Count	remove_reference ()
	Decrement reference count on the handler.
Reference_Counting_Policy &	reference_counting_policy ()
	Current Reference_Counting_Policy.

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

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.

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.
Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.
Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=nullptr, int priority=ACE_Event_Handler::LO_PRIORITY)
	Force ACE_Event_Handler to be an abstract base class.
Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count.

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

TIMER_QUEUE

template<class TQ , class TYPE = ACE_Event_Handler*>

typedef TQ ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::TIMER_QUEUE

Constructor & Destructor Documentation

ACE_Async_Timer_Queue_Adapter()

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

cancel()

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.

expire()

template<class TQ , class TYPE >

int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::expire

(

)

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

handle_signal()

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.

schedule()

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.

schedule_ualarm()

template<class TQ , class TYPE >

int ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::schedule_ualarm ( )

privatevirtual

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

timer_queue()

template<class TQ , class TYPE >

TQ & ACE_Async_Timer_Queue_Adapter< TQ, TYPE >::timer_queue

(

)

Return a reference to the underlying timer queue.

Member Data Documentation

mask_

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.

sig_handler_

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.

timer_queue_

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:

• Timer_Queue_Adapters.h
• Timer_Queue_Adapters.cpp