ACE  6.0.6
Public Types | Public Member Functions | Private Attributes
ACE_Timer_Node_T Class Reference

Maintains the state associated with a Timer entry. More...

#include <Timer_Queue_T.h>

Collaboration diagram for ACE_Timer_Node_T:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
ACE_Timer_Node_Dispatch_Info_T
< TYPE > 
DISPATCH_INFO
 Useful typedef ..

Public Member Functions

 ACE_Timer_Node_T (void)
 Default constructor.
 ~ACE_Timer_Node_T (void)
 Destructor.
void set (const TYPE &type, const void *a, const ACE_Time_Value &t, const ACE_Time_Value &i, ACE_Timer_Node_T< TYPE > *n, long timer_id)
 Singly linked list.
void set (const TYPE &type, const void *a, const ACE_Time_Value &t, const ACE_Time_Value &i, ACE_Timer_Node_T< TYPE > *p, ACE_Timer_Node_T< TYPE > *n, long timer_id)
 Doubly linked list version.
TYPE & get_type (void)
 Get the type.
void set_type (TYPE &type)
 Set the type.
const void * get_act (void)
 Get the asynchronous completion token.
void set_act (void *act)
 Set the asynchronous completion token.
const ACE_Time_Valueget_timer_value (void) const
 Get the timer value.
void set_timer_value (const ACE_Time_Value &timer_value)
 Set the timer value.
const ACE_Time_Valueget_interval (void) const
 Get the timer interval.
void set_interval (const ACE_Time_Value &interval)
 Set the timer interval.
ACE_Timer_Node_T< TYPE > * get_prev (void)
 Get the previous pointer.
void set_prev (ACE_Timer_Node_T< TYPE > *prev)
 Set the previous pointer.
ACE_Timer_Node_T< TYPE > * get_next (void)
 Get the next pointer.
void set_next (ACE_Timer_Node_T< TYPE > *next)
 Set the next pointer.
long get_timer_id (void) const
 Get the timer_id.
void set_timer_id (long timer_id)
 Set the timer_id.
void get_dispatch_info (ACE_Timer_Node_Dispatch_Info_T< TYPE > &info)
void dump (void) const
 Dump the state of an TYPE.

Private Attributes

TYPE type_
 Type of object stored in the Queue.
const void * act_
 Asynchronous completion token associated with the timer.
ACE_Time_Value timer_value_
 Time until the timer expires.
ACE_Time_Value interval_
ACE_Timer_Node_T< TYPE > * prev_
 Pointer to previous timer.
ACE_Timer_Node_T< TYPE > * next_
 Pointer to next timer.
long timer_id_
 Id of this timer (used to cancel timers before they expire).

Detailed Description

Maintains the state associated with a Timer entry.


Member Typedef Documentation

Useful typedef ..


Constructor & Destructor Documentation

ACE_Timer_Node_T::ACE_Timer_Node_T ( void  )

Default constructor.

ACE_Timer_Node_T::~ACE_Timer_Node_T ( void  )

Destructor.


Member Function Documentation

void ACE_Timer_Node_T::dump ( void  ) const

Dump the state of an TYPE.

const void* ACE_Timer_Node_T::get_act ( void  )

Get the asynchronous completion token.

void ACE_Timer_Node_T::get_dispatch_info ( ACE_Timer_Node_Dispatch_Info_T< TYPE > &  info)

Get the dispatch info. The dispatch information is got through <info>. This form helps us in preventing allocation and deleting data along the criticl path. @TODO: We may want to have a copying version too, so that our interface will be complete..

const ACE_Time_Value& ACE_Timer_Node_T::get_interval ( void  ) const

Get the timer interval.

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::get_next ( void  )

Get the next pointer.

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::get_prev ( void  )

Get the previous pointer.

long ACE_Timer_Node_T::get_timer_id ( void  ) const

Get the timer_id.

const ACE_Time_Value& ACE_Timer_Node_T::get_timer_value ( void  ) const

Get the timer value.

TYPE& ACE_Timer_Node_T::get_type ( void  )

Get the type.

void ACE_Timer_Node_T::set ( const TYPE &  type,
const void *  a,
const ACE_Time_Value t,
const ACE_Time_Value i,
ACE_Timer_Node_T< TYPE > *  n,
long  timer_id 
)

Singly linked list.

void ACE_Timer_Node_T::set ( const TYPE &  type,
const void *  a,
const ACE_Time_Value t,
const ACE_Time_Value i,
ACE_Timer_Node_T< TYPE > *  p,
ACE_Timer_Node_T< TYPE > *  n,
long  timer_id 
)

Doubly linked list version.

void ACE_Timer_Node_T::set_act ( void *  act)

Set the asynchronous completion token.

void ACE_Timer_Node_T::set_interval ( const ACE_Time_Value interval)

Set the timer interval.

void ACE_Timer_Node_T::set_next ( ACE_Timer_Node_T< TYPE > *  next)

Set the next pointer.

void ACE_Timer_Node_T::set_prev ( ACE_Timer_Node_T< TYPE > *  prev)

Set the previous pointer.

void ACE_Timer_Node_T::set_timer_id ( long  timer_id)

Set the timer_id.

void ACE_Timer_Node_T::set_timer_value ( const ACE_Time_Value timer_value)

Set the timer value.

void ACE_Timer_Node_T::set_type ( TYPE &  type)

Set the type.


Member Data Documentation

const void* ACE_Timer_Node_T::act_ [private]

Asynchronous completion token associated with the timer.

If this is a periodic timer this holds the time until the next timeout.

Pointer to next timer.

Pointer to previous timer.

Id of this timer (used to cancel timers before they expire).

Time until the timer expires.

TYPE ACE_Timer_Node_T::type_ [private]

Type of object stored in the Queue.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines