ACE 8.0.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
ACE_Timer_Node_T< TYPE > Class Template Reference

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

#include <Timer_Queue_Iterator.h>

Collaboration diagram for ACE_Timer_Node_T< TYPE >:
Collaboration graph
[legend]

Public Types

typedef ACE_Timer_Node_Dispatch_Info_T< TYPE > DISPATCH_INFO
 Useful typedef ..
 

Public Member Functions

 ACE_Timer_Node_T ()
 Default constructor.
 
 ~ACE_Timer_Node_T ()
 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 ()
 Get the type.
 
void set_type (TYPE &type)
 Set the type.
 
const voidget_act ()
 Get the asynchronous completion token.
 
void set_act (void *act)
 Set the asynchronous completion token.
 
const ACE_Time_Valueget_timer_value () const
 Get the timer value.
 
void set_timer_value (const ACE_Time_Value &timer_value)
 Set the timer value.
 
const ACE_Time_Valueget_interval () const
 Get the timer interval.
 
void set_interval (const ACE_Time_Value &interval)
 Set the timer interval.
 
ACE_Timer_Node_T< TYPE > * get_prev ()
 Get the previous pointer.
 
void set_prev (ACE_Timer_Node_T< TYPE > *prev)
 Set the previous pointer.
 
ACE_Timer_Node_T< TYPE > * get_next ()
 Get the next pointer.
 
void set_next (ACE_Timer_Node_T< TYPE > *next)
 Set the next pointer.
 
long get_timer_id () 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 () const
 Dump the state of an TYPE.
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.
 

Private Attributes

TYPE type_
 Type of object stored in the Queue.
 
const voidact_
 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

template<class TYPE>
class ACE_Timer_Node_T< TYPE >

Maintains the state associated with a Timer entry.

Member Typedef Documentation

◆ DISPATCH_INFO

template<class TYPE >
typedef ACE_Timer_Node_Dispatch_Info_T<TYPE> ACE_Timer_Node_T< TYPE >::DISPATCH_INFO

Useful typedef ..

Constructor & Destructor Documentation

◆ ACE_Timer_Node_T()

template<class TYPE >
ACE_Timer_Node_T< TYPE >::ACE_Timer_Node_T ( )

Default constructor.

◆ ~ACE_Timer_Node_T()

template<class TYPE >
ACE_Timer_Node_T< TYPE >::~ACE_Timer_Node_T ( )

Destructor.

Member Function Documentation

◆ dump()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::dump ( ) const

Dump the state of an TYPE.

◆ get_act()

template<class TYPE >
const void * ACE_Timer_Node_T< TYPE >::get_act ( )
inline

Get the asynchronous completion token.

◆ get_dispatch_info()

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

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

◆ get_interval()

template<class TYPE >
const ACE_Time_Value & ACE_Timer_Node_T< TYPE >::get_interval ( ) const
inline

Get the timer interval.

◆ get_next()

template<class TYPE >
ACE_Timer_Node_T< TYPE > * ACE_Timer_Node_T< TYPE >::get_next ( )
inline

Get the next pointer.

◆ get_prev()

template<class TYPE >
ACE_Timer_Node_T< TYPE > * ACE_Timer_Node_T< TYPE >::get_prev ( )
inline

Get the previous pointer.

◆ get_timer_id()

template<class TYPE >
long ACE_Timer_Node_T< TYPE >::get_timer_id ( ) const
inline

Get the timer_id.

◆ get_timer_value()

template<class TYPE >
const ACE_Time_Value & ACE_Timer_Node_T< TYPE >::get_timer_value ( ) const
inline

Get the timer value.

◆ get_type()

template<class TYPE >
TYPE & ACE_Timer_Node_T< TYPE >::get_type ( )
inline

Get the type.

◆ set() [1/2]

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::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 )
inline

Singly linked list.

◆ set() [2/2]

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::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 )
inline

Doubly linked list version.

◆ set_act()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_act ( void * act)
inline

Set the asynchronous completion token.

◆ set_interval()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_interval ( const ACE_Time_Value & interval)
inline

Set the timer interval.

◆ set_next()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_next ( ACE_Timer_Node_T< TYPE > * next)
inline

Set the next pointer.

◆ set_prev()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_prev ( ACE_Timer_Node_T< TYPE > * prev)
inline

Set the previous pointer.

◆ set_timer_id()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_timer_id ( long timer_id)
inline

Set the timer_id.

◆ set_timer_value()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_timer_value ( const ACE_Time_Value & timer_value)
inline

Set the timer value.

◆ set_type()

template<class TYPE >
void ACE_Timer_Node_T< TYPE >::set_type ( TYPE & type)
inline

Set the type.

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

template<class TYPE >
ACE_Timer_Node_T< TYPE >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ act_

template<class TYPE >
const void* ACE_Timer_Node_T< TYPE >::act_
private

Asynchronous completion token associated with the timer.

◆ interval_

template<class TYPE >
ACE_Time_Value ACE_Timer_Node_T< TYPE >::interval_
private

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

◆ next_

template<class TYPE >
ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T< TYPE >::next_
private

Pointer to next timer.

◆ prev_

template<class TYPE >
ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T< TYPE >::prev_
private

Pointer to previous timer.

◆ timer_id_

template<class TYPE >
long ACE_Timer_Node_T< TYPE >::timer_id_
private

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

◆ timer_value_

template<class TYPE >
ACE_Time_Value ACE_Timer_Node_T< TYPE >::timer_value_
private

Time until the timer expires.

◆ type_

template<class TYPE >
TYPE ACE_Timer_Node_T< TYPE >::type_
private

Type of object stored in the Queue.


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