Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CTimer Class Reference

#include <Timer.h>

Inheritance diagram for CTimer:
CThread PVR::CPVRManager::CLastWatchedUpdateTimer

Public Member Functions

 CTimer (ITimerCallback *callback)
 
 CTimer (std::function< void()> const &callback)
 
 ~CTimer () override
 
bool Start (uint32_t timeout, bool interval=false)
 
bool Stop (bool wait=false)
 
bool Restart ()
 
void RestartAsync (uint32_t timeout)
 
bool IsRunning () const
 
float GetElapsedSeconds () const
 
float GetElapsedMilliseconds () const
 

Protected Member Functions

void Process () override
 
- Protected Member Functions inherited from CThread
 CThread (const char *ThreadName)
 
virtual void OnStartup ()
 
virtual void OnExit ()
 
WaitResponse AbortableWait (CEvent &event, int timeoutMillis=-1)
 
 CThread (IRunnable *pRunnable, const char *ThreadName)
 
virtual ~CThread ()
 
void Create (bool bAutoDelete=false, unsigned stacksize=0)
 
void Sleep (unsigned int milliseconds)
 
int GetSchedRRPriority (void)
 
bool SetPrioritySched_RR (int iPriority)
 
bool IsAutoDelete () const
 
virtual void StopThread (bool bWait=true)
 
bool IsRunning () const
 
bool IsCurrentThread () const
 
int GetMinPriority (void)
 
int GetMaxPriority (void)
 
int GetNormalPriority (void)
 
int GetPriority (void)
 
bool SetPriority (const int iPriority)
 
bool WaitForThreadExit (unsigned int milliseconds)
 
float GetRelativeUsage ()
 
int64_t GetAbsoluteUsage ()
 
virtual void OnException ()
 

Additional Inherited Members

- Protected Types inherited from CThread
enum  WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }
 
- Static Protected Member Functions inherited from CThread
static bool IsCurrentThread (const ThreadIdentifier tid)
 
static ThreadIdentifier GetCurrentThreadId ()
 
static ThreadIdentifier GetDisplayThreadId (const ThreadIdentifier tid)
 
static CThreadGetCurrentThread ()
 
- Protected Attributes inherited from CThread
std::atomic< bool > m_bStop
 

Constructor & Destructor Documentation

◆ CTimer() [1/2]

CTimer::CTimer ( ITimerCallback callback)
explicit

◆ CTimer() [2/2]

CTimer::CTimer ( std::function< void()> const &  callback)
explicit

◆ ~CTimer()

CTimer::~CTimer ( )
override

Member Function Documentation

◆ GetElapsedMilliseconds()

float CTimer::GetElapsedMilliseconds ( ) const

◆ GetElapsedSeconds()

float CTimer::GetElapsedSeconds ( ) const

◆ IsRunning()

bool CTimer::IsRunning ( ) const
inline

◆ Process()

void CTimer::Process ( void  )
overrideprotectedvirtual

Reimplemented from CThread.

◆ Restart()

bool CTimer::Restart ( )

◆ RestartAsync()

void CTimer::RestartAsync ( uint32_t  timeout)

◆ Start()

bool CTimer::Start ( uint32_t  timeout,
bool  interval = false 
)

◆ Stop()

bool CTimer::Stop ( bool  wait = false)

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