TrcTimer Class Reference

#include <TrcTimer.h>

List of all members.

Public Member Functions

 TrcTimer (void)
 ~TrcTimer (void)
bool SetTimer (__in double delay, __in TimerNotify *notify, __in void *context=NULL)
void CancelTimer (void)

Detailed Description

This class defines the timer object. It allows the caller to set a timer and notifies the caller when the timer expires.


Constructor & Destructor Documentation

TrcTimer::TrcTimer ( void   )  [inline]

Constructor: Create an instance of the TrcTimer object.

TrcTimer::~TrcTimer ( void   )  [inline]

Destructor: Destroy an instance of the TrcTimer object.


Member Function Documentation

void TrcTimer::CancelTimer ( void   )  [inline]

This function cancels a pending timer.

bool TrcTimer::SetTimer ( __in double  delay,
__in TimerNotify notify,
__in void *  context = NULL 
) [inline]

This function sets a timer to be expired with a given delay.

Parameters:
delay Specifies the amount of time in seconds the timer will expire.
notify Points to the TimerNotify object for the callback.
context Specifies the context to be passed back on the callback.
Returns:
Returns true if success, false otherwise.

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

Generated by  doxygen 1.6.2