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

Adapts an ACE timer queue using a separate thread for dispatching. More...

#include <Timer_Queue_Adapters.h>

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

Public Types

typedef TQ TIMER_QUEUE
 Trait for the underlying queue type. More...
 
- 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_Thread_Timer_Queue_Adapter (ACE_Thread_Manager *=ACE_Thread_Manager::instance(), TQ *timer_queue=0)
 
virtual ~ACE_Thread_Timer_Queue_Adapter (void)
 Destructor. More...
 
long schedule (TYPE 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. More...
 
virtual void deactivate (void)
 Inform the dispatching thread that it should terminate. More...
 
ACE_SYNCH_RECURSIVE_MUTEXmutex (void)
 Access the locking mechanism, useful for iteration. More...
 
int timer_queue (TQ *tq)
 Set a user-specified timer queue. More...
 
TQ * timer_queue (void) const
 Return the current <TQ>. More...
 
ACE_thread_t thr_id (void) const
 Return the thread id of our active object. More...
 
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_ids[]=0, const char *thr_name[]=0)
 
- Public Member Functions inherited from ACE_Task_Base
 ACE_Task_Base (ACE_Thread_Manager *=0)
 Constructor. More...
 
virtual ~ACE_Task_Base (void)
 Destructor. More...
 
virtual int open (void *args=0)
 Default ACE_Task open routine. More...
 
virtual int close (u_long flags=0)
 Default ACE_Task close routine. More...
 
virtual int module_closed (void)
 
virtual int put (ACE_Message_Block *, ACE_Time_Value *=0)
 Default ACE_Task put routine. More...
 
virtual int wait (void)
 Wait for all threads running in a task to exit. More...
 
virtual int suspend (void)
 Suspend a task. More...
 
virtual int resume (void)
 Resume a suspended task. More...
 
int grp_id (void) const
 Get the current group id. More...
 
void grp_id (int)
 Set the current group id. More...
 
ACE_Thread_Managerthr_mgr (void) const
 Get the thread manager associated with this Task. More...
 
void thr_mgr (ACE_Thread_Manager *)
 Set the thread manager associated with this Task. More...
 
int is_reader (void) const
 True if queue is a reader, else false. More...
 
int is_writer (void) const
 True if queue is a writer, else false. More...
 
size_t thr_count (void) const
 
ACE_thread_t last_thread (void) const
 
- Public Member Functions inherited from ACE_Service_Object
 ACE_Service_Object (ACE_Reactor *=0)
 Constructor. More...
 
virtual ~ACE_Service_Object (void)
 Destructor. 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 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_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...
 
- Public Member Functions inherited from ACE_Shared_Object
 ACE_Shared_Object (void)
 Constructor. More...
 
virtual ~ACE_Shared_Object (void)
 Destructor. More...
 
virtual int init (int argc, ACE_TCHAR *argv[])
 Initializes object when dynamic linking occurs. More...
 
virtual int fini (void)
 Terminates object when dynamic unlinking occurs. More...
 
virtual int info (ACE_TCHAR **info_string, size_t length=0) const
 Returns information on a service object. More...
 

Private Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from ACE_Task_Base
static ACE_THR_FUNC_RETURN svc_run (void *)
 Routine that runs the service routine as a daemon thread. More...
 
static void cleanup (void *object, void *params)
 
- 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_Task_Base
size_t thr_count_
 
ACE_Thread_Managerthr_mgr_
 Multi-threading manager. More...
 
u_long flags_
 ACE_Task flags. More...
 
int grp_id_
 This maintains the group id of the Task. More...
 
ACE_thread_t last_thread_id_
 Holds the thread ID of the last thread to exit svc() in this object. 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_Thread_Timer_Queue_Adapter< TQ, TYPE >

Adapts an ACE timer queue using a separate thread for dispatching.

This implementation 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 , class TYPE = ACE_Event_Handler*>
typedef TQ ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::TIMER_QUEUE

Trait for the underlying queue type.

Constructor & Destructor Documentation

template<class TQ , class TYPE >
ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::ACE_Thread_Timer_Queue_Adapter ( ACE_Thread_Manager tm = 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 , class TYPE >
ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::~ACE_Thread_Timer_Queue_Adapter ( void  )
virtual

Destructor.

Member Function Documentation

template<class TQ , class TYPE >
int ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::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_ids[] = 0,
const char *  thr_name[] = 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 , class TYPE >
int ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::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 , class TYPE >
void ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::deactivate ( void  )
virtual

Inform the dispatching thread that it should terminate.

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

Access the locking mechanism, useful for iteration.

template<class TQ , class TYPE >
long ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::schedule ( TYPE  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 , class TYPE >
int ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::svc ( void  )
virtual

Runs the dispatching thread.

Reimplemented from ACE_Task_Base.

template<class TQ , class TYPE >
ACE_thread_t ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::thr_id ( void  ) const
inline

Return the thread id of our active object.

template<class TQ , class TYPE >
int ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::timer_queue ( TQ *  tq)
inline

Set a user-specified timer queue.

template<class TQ , class TYPE >
TQ * ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::timer_queue ( void  ) const
inline

Return the current <TQ>.

Member Data Documentation

template<class TQ , class TYPE = ACE_Event_Handler*>
bool ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::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 , class TYPE = ACE_Event_Handler*>
ACE_SYNCH_RECURSIVE_CONDITION ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::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 , class TYPE = ACE_Event_Handler*>
bool ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::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 , class TYPE = ACE_Event_Handler*>
ACE_SYNCH_RECURSIVE_MUTEX ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::mutex_
private

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

template<class TQ , class TYPE = ACE_Event_Handler*>
ACE_thread_t ACE_Thread_Timer_Queue_Adapter< TQ, TYPE >::thr_id_
private

Thread id of our active object task.

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

The underlying Timer_Queue.


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