# ACE_Thread_Timer_Queue_Adapter< TQ > Class Template Reference

Adapts a Timer_Queue using a separate thread for dispatching. More...

`#include <Timer_Queue_Adapters.h>`

Inheritance diagram for ACE_Thread_Timer_Queue_Adapter< TQ >:

[legend]
Collaboration diagram for ACE_Thread_Timer_Queue_Adapter< TQ >:

[legend]
List of all members.

## Public Types

typedef TQ | TIMER_QUEUE
| Trait for the underlying queue type.

## Public Member Functions

| ACE_Thread_Timer_Queue_Adapter (ACE_Thread_Manager *=ACE_Thread_Manager::instance(), TQ *timer_queue=0)
virtual | ~ACE_Thread_Timer_Queue_Adapter (void)
| Destructor.
long | schedule (ACE_Event_Handler *handler, 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)
virtual int | svc (void)
| Runs the dispatching thread.
virtual void | deactivate (void)
| Inform the dispatching thread that it should terminate.
ACE_SYNCH_RECURSIVE_MUTEX & | mutex (void)
| Access the locking mechanism, useful for iteration.
int | timer_queue (TQ *tq)
| Set a user-specified timer queue.
TQ * | timer_queue (void) const
| Return the current <tq>.
ACE_thread_t | thr_id (void) const
| Return the thread id of our active object.
virtual int | activate (long flags=THR_NEW_LWP|THR_JOINABLE, int n_threads=1, int force_active=0, long priority=ACE_DEFAULT_THREAD_PRIORITY, int grp_id=-1, ACE_Task_Base *task=0, ACE_hthread_t thread_handles[]=0, void *stack[]=0, size_t stack_size[]=0, ACE_thread_t thread_names[]=0)

## Private Attributes

TQ * | timer_queue_
| The underlying Timer_Queue.
int | delete_timer_queue_
ACE_SYNCH_RECURSIVE_MUTEX | mutex_
ACE_SYNCH_RECURSIVE_CONDITION | condition_
int | active_
ACE_thread_t | thr_id_
| Thread id of our active object task.

## Detailed Description

### template<class TQ>
class ACE_Thread_Timer_Queue_Adapter< TQ >

Adapts a Timer_Queue using a separate thread for dispatching.

This implementation of a Timer_Queue uses a separate thread to dispatch the timers. The base queue need not be thread safe, this class takes all the necessary locks.

Note:
  This is a case where template parameters will be useful, but (IMHO) the effort and portability problems discourage their use.

## Member Typedef Documentation

template<class TQ>
typedef TQ ACE_Thread_Timer_Queue_Adapter< TQ >::TIMER_QUEUE

| Trait for the underlying queue type.

## Constructor & Destructor Documentation

template<class TQ>
ACE_Thread_Timer_Queue_Adapter< TQ >::ACE_Thread_Timer_Queue_Adapter | ( | ACE_Thread_Manager * | = `ACE_Thread_Manager::instance()`,
|  | TQ * | timer_queue = `0`
| ) |

| Creates the timer queue. Activation of the task is the user's responsibility. Optionally a pointer to a timer queue can be passed, when no pointer is passed, a TQ is dynamically created

template<class TQ>
ACE_Thread_Timer_Queue_Adapter< TQ >::~ACE_Thread_Timer_Queue_Adapter | ( | void |  | ) | `[virtual]`

| Destructor.

## Member Function Documentation

template<class TQ>
int ACE_Thread_Timer_Queue_Adapter< TQ >::activate | ( | long | flags = `THR_NEW_LWP|THR_JOINABLE`,
|  | int | n_threads = `1`,
|  | int | force_active = `0`,
|  | long | priority = `ACE_DEFAULT_THREAD_PRIORITY`,
|  | int | grp_id = `-1`,
|  | ACE_Task_Base * | task = `0`,
|  | ACE_hthread_t | thread_handles[] = `0`,
|  | void * | stack[] = `0`,
|  | size_t | stack_size[] = `0`,
|  | ACE_thread_t | thread_names[] = `0`
| ) | `[virtual]`

| We override the default activate() method so that we can ensure that only a single thread is ever spawned. Otherwise, too many weird things can happen... Reimplemented from ACE_Task_Base.

template<class TQ>
int ACE_Thread_Timer_Queue_Adapter< TQ >::cancel | ( | long | timer_id,
|  | const void ** | act = `0`
| ) |

| Cancel the timer_id and return the act parameter if an address is passed in. Also wakes up the dispatching thread.

template<class TQ>
void ACE_Thread_Timer_Queue_Adapter< TQ >::deactivate | ( | void |  | ) | `[virtual]`

| Inform the dispatching thread that it should terminate.

template<class TQ>
ACE_SYNCH_RECURSIVE_MUTEX & ACE_Thread_Timer_Queue_Adapter< TQ >::mutex | ( | void |  | ) |

| Access the locking mechanism, useful for iteration.

template<class TQ>
long ACE_Thread_Timer_Queue_Adapter< TQ >::schedule | ( | ACE_Event_Handler * | handler,
|  | 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 <tq>; wakes up the dispatching thread.

template<class TQ>
int ACE_Thread_Timer_Queue_Adapter< TQ >::svc | ( | void |  | ) | `[virtual]`

| Runs the dispatching thread. Reimplemented from ACE_Task_Base.

template<class TQ>
ACE_INLINE ACE_thread_t ACE_Thread_Timer_Queue_Adapter< TQ >::thr_id | ( | void |  | ) | const

| Return the thread id of our active object.

template<class TQ>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TQ * ACE_Thread_Timer_Queue_Adapter< TQ >::timer_queue | ( | void |  | ) | const

| Return the current <tq>.

template<class TQ>
ACE_INLINE int ACE_Thread_Timer_Queue_Adapter< TQ >::timer_queue | ( | TQ * | tq | ) |

| Set a user-specified timer queue.

## Member Data Documentation

template<class TQ>
int ACE_Thread_Timer_Queue_Adapter< TQ >::active_ `[private]`

| When deactivate is called this variable turns to false and the dispatching thread is signalled, to terminate its main loop.

template<class TQ>
ACE_SYNCH_RECURSIVE_CONDITION ACE_Thread_Timer_Queue_Adapter< TQ >::condition_ `[private]`

| The dispatching thread sleeps on this condition while waiting to dispatch the next timer; it is used to wake it up if there is a change on the timer queue.

template<class TQ>
int ACE_Thread_Timer_Queue_Adapter< TQ >::delete_timer_queue_ `[private]`

| Keeps track of whether we should delete the timer queue (if we didn't create it, then we don't delete it).

template<class TQ>
ACE_SYNCH_RECURSIVE_MUTEX ACE_Thread_Timer_Queue_Adapter< TQ >::mutex_ `[private]`

| The mutual exclusion mechanism that is required to use the <condition_>.

template<class TQ>
ACE_thread_t ACE_Thread_Timer_Queue_Adapter< TQ >::thr_id_ `[private]`

| Thread id of our active object task.

template<class TQ>
TQ* ACE_Thread_Timer_Queue_Adapter< TQ >::timer_queue_ `[private]`

| The underlying Timer_Queue.

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

- Timer_Queue_Adapters.h
- Timer_Queue_Adapters.cpp
- Timer_Queue_Adapters.inl