|
Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
|
#include <Timer.h>
Classes | |
| class | ITimerCallback |
Public Member Functions | |
| CTimer (kodi::tools::CTimer::ITimerCallback *callback) | |
| Class constructor to pass individual other class as callback. More... | |
| CTimer (std::function< void()> const &callback) | |
| Class constructor to pass individual function as callback. More... | |
| ~CTimer () override | |
| Class destructor. More... | |
| bool | Start (uint64_t timeout, bool interval=false) |
| Start the timer by given time in milliseconds to make his call by arrive of them. More... | |
| bool | Stop (bool wait=false) |
| Stop the timer if it is active. More... | |
| bool | Restart () |
| Restart timer complete by stop and restart his thread again. More... | |
| void | RestartAsync (uint64_t timeout) |
| Restart the timer with new timeout without touch of his thread. More... | |
| bool | IsRunning () const |
| Check timer is still active to wait for next call. More... | |
| float | GetElapsedSeconds () const |
| Get elapsed time as floating point of timer as seconds. More... | |
| float | GetElapsedMilliseconds () const |
| Get elapsed time as floating point of timer as milliseconds. More... | |
Protected Member Functions | |
| void | Process () override |
| The function to be added by the addon as a child to carry out the process thread. More... | |
| CThread () | |
| Class constructor. More... | |
| virtual | ~CThread () |
| Class destructor. More... | |
| bool | IsAutoDelete () const |
| Check auto delete is enabled on this thread class. More... | |
| bool | IsCurrentThread () const |
| Check caller is on this running thread. More... | |
| bool | IsRunning () const |
| Check thread inside this class is running and active. More... | |
| void | CreateThread (bool autoDelete=false) |
| Create a new thread defined by this class on child. More... | |
| void | StopThread (bool wait=true) |
| Stop a running thread. More... | |
| void | Sleep (uint32_t milliseconds) |
| Thread sleep with given amount of milliseconds. More... | |
| bool | Join (unsigned int milliseconds) |
| The function returns when the thread execution has completed or timing is reached in milliseconds beforehand. More... | |
Additional Inherited Members | |
Protected Attributes inherited from kodi::tools::CThread | |
| std::atomic< bool > | m_threadStop |
| Atomic bool to indicate thread is active. More... | |
|
inlineoverrideprotectedvirtual |
The function to be added by the addon as a child to carry out the process thread.
Use m_threadStop to check about active of thread and want stopped from external place.
Implements kodi::tools::CThread.