diff options
Diffstat (limited to 'ACE/ace/Countdown_Time.h')
-rw-r--r-- | ACE/ace/Countdown_Time.h | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/ACE/ace/Countdown_Time.h b/ACE/ace/Countdown_Time.h index bb7dff364d7..58f74c235e9 100644 --- a/ACE/ace/Countdown_Time.h +++ b/ACE/ace/Countdown_Time.h @@ -30,7 +30,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL * * @brief Keeps track of the amount of elapsed time. * - * This class has a side-effect on the <max_wait_time> -- every + * This class has a side-effect on the @c max_wait_time -- every * time the <stop> method is called the <max_wait_time> is * updated. */ @@ -38,25 +38,26 @@ class ACE_Export ACE_Countdown_Time { public: // = Initialization and termination methods. - /// Cache the <max_wait_time> and call <start>. + /// Cache the @a max_wait_time and call @c start(). ACE_Countdown_Time (ACE_Time_Value *max_wait_time); - /// Call <stop>. + /// Destructor, makes sure the max_wait_time that got passed as pointer + /// to the constructor is updated with the time elapsed. ~ACE_Countdown_Time (void); /// Cache the current time and enter a start state. - int start (void); + void start (void); /// Subtract the elapsed time from max_wait_time_ and enter a stopped /// state. - int stop (void); + void stop (void); /// Calls stop and then start. max_wait_time_ is modified by the /// call to stop. - int update (void); + void update (void); - /// Returns 1 if we've already been stopped, else 0. - int stopped (void) const; + /// Returns true if we've already been stopped, else false. + bool stopped (void) const; private: /// Maximum time we were willing to wait. @@ -66,7 +67,7 @@ private: ACE_Time_Value start_time_; /// Keeps track of whether we've already been stopped. - int stopped_; + bool stopped_; // Prevent copying ACE_Countdown_Time (const ACE_Countdown_Time &); |