iodrivers_base
Public Member Functions | List of all members
iodrivers_base::Timeout Class Reference

#include <Timeout.hpp>

Public Member Functions

 Timeout (unsigned int timeout=0)
 
void restart ()
 
bool elapsed () const
 
bool elapsed (unsigned int timeout) const
 
unsigned int timeLeft () const
 
unsigned int timeLeft (unsigned int timeout) const
 

Detailed Description

A timeout tracking class

Constructor & Destructor Documentation

Timeout::Timeout ( unsigned int  timeout = 0)

Initializes and starts a timeout

Parameters
timeouttime in ms

Member Function Documentation

bool Timeout::elapsed ( ) const

Checks if the timeout is already elapsed. This uses a syscall, so use sparingly and cache results

Returns
true if the timeout is elapsed
bool Timeout::elapsed ( unsigned int  timeout) const

Checks if the timeout is already elapsed. This uses a syscall, so use sparingly and cache results

Parameters
timeouta custom timeout
Returns
true if the timeout is elapsed
void Timeout::restart ( )

Restarts the timeout

unsigned int Timeout::timeLeft ( ) const

Calculates the time left for this timeout This uses a syscall, so use sparingly and cache results

Returns
number of milliseconds this timeout as left
unsigned int Timeout::timeLeft ( unsigned int  timeout) const

Calculates the time left for this timeout This uses a syscall, so use sparingly and cache results

Parameters
timeouta custom timeout
Returns
number of milliseconds this timeout as left

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