ACE_Timer_Node_T Class Reference

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

#include <Timer_Queue_Iterator.h>

Collaboration diagram for ACE_Timer_Node_T:

Public Types
typedef ACE_Timer_Node_Dispatch_Info_T< TYPE >	DISPATCH_INFO
	Useful typedef .. More...

Public Member Functions
	ACE_Timer_Node_T (void)
	Default constructor. More...
	~ACE_Timer_Node_T (void)
	Destructor. More...
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. More...
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. More...
TYPE &	get_type (void)
	Get the type. More...
void	set_type (TYPE &type)
	Set the type. More...
const void *	get_act (void)
	Get the asynchronous completion token. More...
void	set_act (void *act)
	Set the asynchronous completion token. More...
const ACE_Time_Value &	get_timer_value (void) const
	Get the timer value. More...
void	set_timer_value (const ACE_Time_Value &timer_value)
	Set the timer value. More...
const ACE_Time_Value &	get_interval (void) const
	Get the timer interval. More...
void	set_interval (const ACE_Time_Value &interval)
	Set the timer interval. More...
ACE_Timer_Node_T< TYPE > *	get_prev (void)
	Get the previous pointer. More...
void	set_prev (ACE_Timer_Node_T< TYPE > *prev)
	Set the previous pointer. More...
ACE_Timer_Node_T< TYPE > *	get_next (void)
	Get the next pointer. More...
void	set_next (ACE_Timer_Node_T< TYPE > *next)
	Set the next pointer. More...
long	get_timer_id (void) const
	Get the timer_id. More...
void	set_timer_id (long timer_id)
	Set the timer_id. More...
void	get_dispatch_info (ACE_Timer_Node_Dispatch_Info_T< TYPE > &info)
void	dump (void) const
	Dump the state of an TYPE. More...

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

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

Detailed Description

Maintains the state associated with a Timer entry.

Member Typedef Documentation

DISPATCH_INFO

typedef ACE_Timer_Node_Dispatch_Info_T<TYPE> ACE_Timer_Node_T::DISPATCH_INFO

Useful typedef ..

Constructor & Destructor Documentation

ACE_Timer_Node_T()

ACE_Timer_Node_T::ACE_Timer_Node_T

(

void

)

Default constructor.

~ACE_Timer_Node_T()

ACE_Timer_Node_T::~ACE_Timer_Node_T

(

void

)

Destructor.

Member Function Documentation

dump()

void ACE_Timer_Node_T::dump

(

void

)

const

Dump the state of an TYPE.

get_act()

const void* ACE_Timer_Node_T::get_act

(

void

)

Get the asynchronous completion token.

get_dispatch_info()

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

get_interval()

const ACE_Time_Value& ACE_Timer_Node_T::get_interval

(

void

)

const

Get the timer interval.

get_next()

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::get_next

(

void

)

Get the next pointer.

get_prev()

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::get_prev

(

void

)

Get the previous pointer.

get_timer_id()

long ACE_Timer_Node_T::get_timer_id

(

void

)

const

Get the timer_id.

get_timer_value()

const ACE_Time_Value& ACE_Timer_Node_T::get_timer_value

(

void

)

const

Get the timer value.

get_type()

TYPE& ACE_Timer_Node_T::get_type

(

void

)

Get the type.

set() [1/2]

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.

set() [2/2]

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.

set_act()

void ACE_Timer_Node_T::set_act

(

void *

act

)

Set the asynchronous completion token.

set_interval()

void ACE_Timer_Node_T::set_interval

(

const ACE_Time_Value &

interval

)

Set the timer interval.

set_next()

void ACE_Timer_Node_T::set_next

(

ACE_Timer_Node_T< TYPE > *

next

)

Set the next pointer.

set_prev()

void ACE_Timer_Node_T::set_prev

(

ACE_Timer_Node_T< TYPE > *

prev

)

Set the previous pointer.

set_timer_id()

void ACE_Timer_Node_T::set_timer_id

(

long

timer_id

)

Set the timer_id.

set_timer_value()

void ACE_Timer_Node_T::set_timer_value

(

const ACE_Time_Value &

timer_value

)

Set the timer value.

set_type()

void ACE_Timer_Node_T::set_type

(

TYPE &

type

)

Set the type.

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

ACE_Timer_Node_T::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

act_

const void* ACE_Timer_Node_T::act_

private

Asynchronous completion token associated with the timer.

interval_

ACE_Time_Value ACE_Timer_Node_T::interval_

private

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

next_

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::next_

private

Pointer to next timer.

prev_

ACE_Timer_Node_T<TYPE>* ACE_Timer_Node_T::prev_

private

Pointer to previous timer.

timer_id_

long ACE_Timer_Node_T::timer_id_

private

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

timer_value_

ACE_Time_Value ACE_Timer_Node_T::timer_value_

private

Time until the timer expires.

type_

TYPE ACE_Timer_Node_T::type_

private

Type of object stored in the Queue.

---

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

• Abstract_Timer_Queue.h
• Timer_Queue_Iterator.h