CTimeout Class Reference

This class provies simple timing functionality. More...

#include <Timeout.h>

List of all members.

Public Member Functions

virtual ~CTimeout ()

Destructor.

void SetValue (DWORD dwTime)

Sets the value of the timeout.

DWORD GetValue ()

Returns the current timeout value.

void Reset (DWORD dwTime=0)

Starts the timer.

void ResetTo (DWORD dwTimeout, DWORD dwTime=0)

Starts the timer at the specified time.

BOOL IsValid (DWORD dwTime=0)

Returns non-zero if the timer is timming and has not timed out.

BOOL IsExpired (DWORD dwTime=0)

Returns non-zero if the timer is timming and has timed out.

void Expire ()

Expires the timer.

void Zero ()

Sets the timer to invalid state.

Detailed Description

This class provies simple timing functionality.

Use this class to determine the passage of time within one milli-second. For better accuracy, use CHqTimer

Member Function Documentation

BOOL CTimeout::IsExpired ( DWORD dwTime = 0 ) [inline]

Returns non-zero if the timer is timming and has timed out.

Parameters:

[in] dwTime - Current timer value

BOOL CTimeout::IsValid ( DWORD dwTime = 0 ) [inline]

Returns non-zero if the timer is timming and has not timed out.

Parameters:

[in] dwTime - Current timer value

void CTimeout::Reset ( DWORD dwTime = 0 ) [inline]

Starts the timer.

Parameters:

[in] dwTime - Current timer value

void CTimeout::ResetTo ( DWORD dwTimeout,

DWORD dwTime = 0

) [inline]

Starts the timer at the specified time.

Parameters:

[in] dwTimeout - Timeout value in milliseconds

[in] dwTime - Current timer value

void CTimeout::SetValue ( DWORD dwTime ) [inline]

Sets the value of the timeout.

Parameters:

[in] dwTime - Time value in milliseconds

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

inc/Timeout.h