ACE_Countdown_Time_T< TIME_POLICY > Class Template Reference

#include <Countdown_Time_T.h>

Inheritance diagram for ACE_Countdown_Time_T< TIME_POLICY >:

Collaboration diagram for ACE_Countdown_Time_T< TIME_POLICY >:

List of all members.

Public Member Functions
	ACE_Countdown_Time_T (ACE_Time_Value *max_wait_time, TIME_POLICY const &time_policy=TIME_POLICY())
	Cache the max_wait_time and call start().
	~ACE_Countdown_Time_T (void)
void	start (void)
	Cache the current time and enter a start state.
void	stop (void)
void	update (void)
bool	stopped (void) const
	Returns true if we've already been stopped, else false.
void	set_time_policy (TIME_POLICY const &time_policy)
Private Attributes
TIME_POLICY	time_policy_
	The policy to return the current time of day.
ACE_Time_Value *	max_wait_time_
	Maximum time we were willing to wait.
ACE_Time_Value	start_time_
	Beginning of the start time.
bool	stopped_
	Keeps track of whether we've already been stopped.

template<typename TIME_POLICY = ACE_Default_Time_Policy>
class ACE_Countdown_Time_T< TIME_POLICY >

---

Constructor & Destructor Documentation

template<typename TIME_POLICY >

ACE_Countdown_Time_T< TIME_POLICY >::ACE_Countdown_Time_T	(	ACE_Time_Value *	max_wait_time,
		TIME_POLICY const &	time_policy = TIME_POLICY()
	)		[inline]

Cache the max_wait_time and call start().

template<typename TIME_POLICY >

ACE_Countdown_Time_T< TIME_POLICY >::~ACE_Countdown_Time_T

(

void

)

[inline]

Destructor, makes sure the max_wait_time that got passed as pointer to the constructor is updated with the time elapsed.

---

Member Function Documentation

template<typename TIME_POLICY >

void ACE_Countdown_Time_T< TIME_POLICY >::set_time_policy

(

TIME_POLICY const &

time_policy

)

[inline]

Allows applications to control how the timer queue gets the time of day.

template<typename TIME_POLICY >

void ACE_Countdown_Time_T< TIME_POLICY >::start

(

void

)

[inline]

Cache the current time and enter a start state.

template<typename TIME_POLICY >

void ACE_Countdown_Time_T< TIME_POLICY >::stop

(

void

)

[inline]

Subtract the elapsed time from max_wait_time_ and enter a stopped state.

template<typename TIME_POLICY >

bool ACE_Countdown_Time_T< TIME_POLICY >::stopped

(

void

)

const [inline]

Returns true if we've already been stopped, else false.

template<typename TIME_POLICY >

void ACE_Countdown_Time_T< TIME_POLICY >::update

(

void

)

[inline]

Calls stop and then start. max_wait_time_ is modified by the call to stop.

---

Member Data Documentation

template<typename TIME_POLICY = ACE_Default_Time_Policy>

ACE_Time_Value* ACE_Countdown_Time_T< TIME_POLICY >::max_wait_time_ [private]

Maximum time we were willing to wait.

template<typename TIME_POLICY = ACE_Default_Time_Policy>

ACE_Time_Value ACE_Countdown_Time_T< TIME_POLICY >::start_time_ [private]

Beginning of the start time.

template<typename TIME_POLICY = ACE_Default_Time_Policy>

bool ACE_Countdown_Time_T< TIME_POLICY >::stopped_ [private]

Keeps track of whether we've already been stopped.

template<typename TIME_POLICY = ACE_Default_Time_Policy>

TIME_POLICY ACE_Countdown_Time_T< TIME_POLICY >::time_policy_ [private]

The policy to return the current time of day.

---

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

• Countdown_Time_T.h
• Countdown_Time_T.cpp
• Countdown_Time_T.inl