ACE_Countdown_Time Class Reference

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

#include <Countdown_Time.h>

Collaboration diagram for ACE_Countdown_Time:

[legend]List of all members.

Public Member Functions
	ACE_Countdown_Time (ACE_Time_Value *max_wait_time)
	Cache the max_wait_time and call start().
	~ACE_Countdown_Time (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.
Private Member Functions
	ACE_Countdown_Time (const ACE_Countdown_Time &)
ACE_Countdown_Time &	operator= (const ACE_Countdown_Time &)
Private Attributes
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.

---

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 37 of file Countdown_Time.h.

---

Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_Countdown_Time::ACE_Countdown_Time

(

ACE_Time_Value *

max_wait_time

)

Cache the max_wait_time and call start().

Definition at line 10 of file Countdown_Time.cpp.

  : max_wait_time_ (max_wait_time),
    stopped_ (false)
{
  this->start ();
}

ACE_Countdown_Time::~ACE_Countdown_Time

(

void

)

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

Definition at line 17 of file Countdown_Time.cpp.

References stop().

{
  this->stop ();
}

ACE_Countdown_Time::ACE_Countdown_Time

(

const ACE_Countdown_Time &

)

[private]

---

Member Function Documentation

ACE_Countdown_Time& ACE_Countdown_Time::operator=

(

const ACE_Countdown_Time &

)

[private]

void ACE_Countdown_Time::start

(

void

)

Cache the current time and enter a start state.

Definition at line 23 of file Countdown_Time.cpp.

References ACE_OS::gettimeofday(), start_time_, and stopped_.

Referenced by update().

{
  if (this->max_wait_time_ != 0)
    {
      this->start_time_ = ACE_OS::gettimeofday ();
      this->stopped_ = false;
    }
}

void ACE_Countdown_Time::stop

(

void

)

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

Definition at line 39 of file Countdown_Time.cpp.

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_ == false)
    {
      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_ = true;
    }
}

bool ACE_Countdown_Time::stopped

(

void

)

const

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

Definition at line 33 of file Countdown_Time.cpp.

References stopped_.

{
  return stopped_;
}

void ACE_Countdown_Time::update

(

void

)

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

Definition at line 60 of file Countdown_Time.cpp.

References start(), and stop().

Referenced by ACE_TP_Reactor::handle_events(), and ACE_Select_Reactor_T< ACE_SELECT_REACTOR_TOKEN >::handle_events().

{
  this->stop ();
  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 63 of file Countdown_Time.h.

Referenced by stop().

ACE_Time_Value ACE_Countdown_Time::start_time_ [private]

Beginning of the start time.

Definition at line 66 of file Countdown_Time.h.

Referenced by start(), and stop().

bool ACE_Countdown_Time::stopped_ [private]

Keeps track of whether we've already been stopped.

Definition at line 69 of file Countdown_Time.h.

Referenced by start(), stop(), and stopped().

---

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

• Countdown_Time.h
• Countdown_Time.cpp

---