XbmcThreads::EndTime Class Reference

#include <SystemClock.h>

Public Member Functions
	EndTime ()=default
	EndTime (unsigned int millisecondsIntoTheFuture)
void	Set (unsigned int millisecondsIntoTheFuture)
bool	IsTimePast () const
unsigned int	MillisLeft () const
void	SetExpired ()
void	SetInfinite ()
bool	IsInfinite (void) const
unsigned int	GetInitialTimeoutValue (void) const
unsigned int	GetStartTime (void) const

Static Public Attributes
static const unsigned int	InfiniteValue = std::numeric_limits<unsigned int>::max()

Detailed Description

DO NOT compare the results from SystemClockMillis() to an expected end time that was calculated by adding a number of milliseconds to some start time. The reason is because the SystemClockMillis could wrap. Instead use this class which uses differences (which are safe across a wrap).

Constructor & Destructor Documentation

EndTime() [1/2]

XbmcThreads::EndTime::EndTime ( )

inlinedefault

EndTime() [2/2]

XbmcThreads::EndTime::EndTime ( unsigned int  millisecondsIntoTheFuture )

inlineexplicit

Member Function Documentation

GetInitialTimeoutValue()

unsigned int XbmcThreads::EndTime::GetInitialTimeoutValue ( void  ) const

inline

GetStartTime()

unsigned int XbmcThreads::EndTime::GetStartTime ( void  ) const

inline

IsInfinite()

bool XbmcThreads::EndTime::IsInfinite ( void  ) const

inline

IsTimePast()

bool XbmcThreads::EndTime::IsTimePast ( ) const

inline

MillisLeft()

unsigned int XbmcThreads::EndTime::MillisLeft ( ) const

inline

Set()

void XbmcThreads::EndTime::Set ( unsigned int  millisecondsIntoTheFuture )

inline

SetExpired()

void XbmcThreads::EndTime::SetExpired ( )

inline

SetInfinite()

void XbmcThreads::EndTime::SetInfinite ( )

inline

Member Data Documentation

InfiniteValue

const unsigned int XbmcThreads::EndTime::InfiniteValue = std::numeric_limits<unsigned int>::max()

static

---

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

• SystemClock.h
• SystemClock.cpp