Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CAlarmClock Class Reference

#include <AlarmClock.h>

Inheritance diagram for CAlarmClock:
CThread

Public Member Functions

 CAlarmClock ()
 
 ~CAlarmClock () override
 
void Start (const std::string &strName, float n_secs, const std::string &strCommand, bool bSilent=false, bool bLoop=false)
 
bool IsRunning () const
 
bool HasAlarm (const std::string &strName)
 
double GetRemaining (const std::string &strName)
 
void Stop (const std::string &strName, bool bSilent=false)
 
void Process () override
 
- Public Member Functions inherited from CThread
 CThread (IRunnable *pRunnable, const char *ThreadName)
 
virtual ~CThread ()
 
void Create (bool bAutoDelete=false)
 
template<typename Rep , typename Period >
void Sleep (std::chrono::duration< Rep, Period > duration)
 
bool IsAutoDelete () const
 
virtual void StopThread (bool bWait=true)
 
bool IsRunning () const
 
bool IsCurrentThread () const
 
bool Join (std::chrono::milliseconds duration)
 
bool SetPriority (const ThreadPriority &priority)
 Set the threads priority. This uses the platforms native threading library to do so.
 
virtual void OnException ()
 

Additional Inherited Members

- Static Public Member Functions inherited from CThread
static const std::thread::id GetCurrentThreadId ()
 
static CThreadGetCurrentThread ()
 
- Protected Types inherited from CThread
enum  WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }
 
- Protected Member Functions inherited from CThread
 CThread (const char *ThreadName)
 
virtual void OnStartup ()
 
virtual void OnExit ()
 
WaitResponse AbortableWait (CEvent &event, std::chrono::milliseconds duration=std::chrono::milliseconds(-1))
 
- Protected Attributes inherited from CThread
std::atomic< boolm_bStop
 

Constructor & Destructor Documentation

◆ CAlarmClock()

CAlarmClock::CAlarmClock ( )

◆ ~CAlarmClock()

CAlarmClock::~CAlarmClock ( )
overridedefault

Member Function Documentation

◆ GetRemaining()

double CAlarmClock::GetRemaining ( const std::string & strName)
inline

◆ HasAlarm()

bool CAlarmClock::HasAlarm ( const std::string & strName)
inline

◆ IsRunning()

bool CAlarmClock::IsRunning ( ) const
inline

◆ Process()

void CAlarmClock::Process ( void )
overridevirtual

Reimplemented from CThread.

◆ Start()

void CAlarmClock::Start ( const std::string & strName,
float n_secs,
const std::string & strCommand,
bool bSilent = false,
bool bLoop = false )

◆ Stop()

void CAlarmClock::Stop ( const std::string & strName,
bool bSilent = false )

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