---

ACE_Countdown_Time Class Reference

Keeps track of the amount of elapsed time. More...

#include <OS.h>

Collaboration diagram for ACE_Countdown_Time:

[legend]List of all members.

Public Methods
	ACE_Countdown_Time (ACE_Time_Value *max_wait_time)
	Cache the <max_wait_time> and call <start>. More...
	~ACE_Countdown_Time (void)
	Call <stop>. More...
int	start (void)
	Cache the current time and enter a start state. More...
int	stop (void)
	Subtract the elapsed time from max_wait_time_ and enter a stopped state. More...
int	update (void)
	Calls stop and then start. max_wait_time_ is modified by the call to stop. More...
int	stopped (void) const
	Returns 1 if we've already been stopped, else 0. More...
Private Attributes
ACE_Time_Value *	max_wait_time_
	Maximum time we were willing to wait. More...
ACE_Time_Value	start_time_
	Beginning of the start time. More...
int	stopped_
	Keeps track of whether we've already been stopped. More...

---

Detailed Description

Keeps track of the amount of elapsed time.

This class has a side-effect on the <max_wait_time> -- every time the <stop> method is called the <max_wait_time> is updated.

Definition at line 668 of file OS.h.

---

Constructor & Destructor Documentation

ACE_Countdown_Time::ACE_Countdown_Time (  ACE_Time_Value *    max_wait_time )

Cache the <max_wait_time> and call <start>. Definition at line 401 of file OS.cpp. References start. : max_wait_time_ (max_wait_time), stopped_ (0) { this->start (); }

ACE_Countdown_Time::~ACE_Countdown_Time (  void    )

Call <stop>. Definition at line 408 of file OS.cpp. References stop. { this->stop (); }

---

Member Function Documentation

ACE_INLINE int ACE_Countdown_Time::start (  void    )

Cache the current time and enter a start state. Definition at line 11094 of file OS.i. References ACE_OS::gettimeofday, max_wait_time_, start_time_, and stopped_. Referenced by ACE_Countdown_Time, and update. { if (this->max_wait_time_ != 0) { this->start_time_ = ACE_OS::gettimeofday (); this->stopped_ = 0; } return 0; }

ACE_INLINE int ACE_Countdown_Time::stop (  void    )

Subtract the elapsed time from max_wait_time_ and enter a stopped state. Definition at line 11111 of file OS.i. References ACE_OS::gettimeofday, max_wait_time_, start_time_, stopped_, and ACE_Time_Value::zero. Referenced by update, and ~ACE_Countdown_Time. { if (this->max_wait_time_ != 0 && this->stopped_ == 0) { ACE_Time_Value elapsed_time = ACE_OS::gettimeofday () - this->start_time_; if (*this->max_wait_time_ > elapsed_time) *this->max_wait_time_ -= elapsed_time; else { // Used all of timeout. *this->max_wait_time_ = ACE_Time_Value::zero; // errno = ETIME; } this->stopped_ = 1; } return 0; }

ACE_INLINE int ACE_Countdown_Time::stopped (  void    )  const

Returns 1 if we've already been stopped, else 0. Definition at line 11105 of file OS.i. References stopped_. { return stopped_; }

ACE_INLINE int ACE_Countdown_Time::update (  void    )

Calls stop and then start. max_wait_time_ is modified by the call to stop. Definition at line 11132 of file OS.i. References start, and stop. Referenced by ACE_WFMO_Reactor::event_handling, ACE_TP_Reactor::handle_events, ACE_Select_Reactor_T::handle_events, ACE_Process_Manager::wait, and ACE_Process::wait. { return this->stop () == 0 && this->start (); }

---

Member Data Documentation

ACE_Time_Value* ACE_Countdown_Time::max_wait_time_ [private]

Maximum time we were willing to wait. Definition at line 694 of file OS.h. Referenced by start, and stop.

ACE_Time_Value ACE_Countdown_Time::start_time_ [private]

Beginning of the start time. Definition at line 697 of file OS.h. Referenced by start, and stop.

int ACE_Countdown_Time::stopped_ [private]

Keeps track of whether we've already been stopped. Definition at line 700 of file OS.h. Referenced by start, stop, and stopped.

---

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

• OS.h
• OS.cpp
• OS.i

---