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

#include <Timeout.hpp>

Public Member Functions

 Timeout (base::Time timeout=base::Time::fromSeconds(0))
 
void restart ()
 
bool elapsed () const
 
bool elapsed (const base::Time &timeout) const
 
base::Time timeLeft () const
 
base::Time timeLeft (const base::Time &timeout) const
 

Detailed Description

A timeout tracking class

Constructor & Destructor Documentation

◆ Timeout()

base::Timeout::Timeout ( base::Time  timeout = base::Time::fromSeconds(0))

Initializes and starts a timeout

Parameters
timeout,ifzero is given the timeout is inactive

Member Function Documentation

◆ elapsed() [1/2]

bool base::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

◆ elapsed() [2/2]

bool base::Timeout::elapsed ( const base::Time 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

◆ restart()

void base::Timeout::restart ( )

Restarts the timeout

◆ timeLeft() [1/2]

Time base::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

◆ timeLeft() [2/2]

Time base::Timeout::timeLeft ( const base::Time 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: