Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
XbmcThreads::EndTime Class Reference

#include <SystemClock.h>

Public Member Functions

 EndTime ()
 
 EndTime (unsigned int millisecondsIntoTheFuture)
 
 EndTime (const EndTime &right)=delete
 
 ~EndTime ()=default
 
void Set (unsigned int millisecondsIntoTheFuture)
 
bool IsTimePast () const
 
unsigned int MillisLeft () const
 
void SetExpired ()
 
void SetInfinite ()
 
bool IsInfinite () const
 
unsigned int GetInitialTimeoutValue () const
 
unsigned int GetStartTime () const
 

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/3]

XbmcThreads::EndTime::EndTime ( )

◆ EndTime() [2/3]

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

◆ EndTime() [3/3]

XbmcThreads::EndTime::EndTime ( const EndTime right)
delete

◆ ~EndTime()

XbmcThreads::EndTime::~EndTime ( )
default

Member Function Documentation

◆ GetInitialTimeoutValue()

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

◆ GetStartTime()

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

◆ IsInfinite()

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

◆ IsTimePast()

bool XbmcThreads::EndTime::IsTimePast ( ) const

◆ MillisLeft()

unsigned int XbmcThreads::EndTime::MillisLeft ( ) const
Todo:
: this is a hack for now

◆ Set()

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

◆ SetExpired()

void XbmcThreads::EndTime::SetExpired ( )
inline

◆ SetInfinite()

void XbmcThreads::EndTime::SetInfinite ( )
inline

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