Inherits CThread.
|
| CTimer (kodi::tools::CTimer::ITimerCallback *callback) |
| Class constructor to pass individual other class as callback.
|
|
| CTimer (std::function< void()> const &callback) |
| Class constructor to pass individual function as callback.
|
|
float | GetElapsedMilliseconds () const |
| Get elapsed time as floating point of timer as milliseconds.
|
|
float | GetElapsedSeconds () const |
| Get elapsed time as floating point of timer as seconds.
|
|
bool | IsRunning () const |
| Check timer is still active to wait for next call.
|
|
bool | Restart () |
| Restart timer complete by stop and restart his thread again.
|
|
void | RestartAsync (uint64_t timeout) |
| Restart the timer with new timeout without touch of his thread.
|
|
bool | Start (uint64_t timeout, bool interval=false) |
| Start the timer by given time in milliseconds to make his call by arrive of them.
|
|
bool | Stop (bool wait=false) |
| Stop the timer if it is active.
|
|
| ~CTimer () override |
| Class destructor.
|
|
|
void | Process () override |
| The function to be added by the addon as a child to carry out the process thread.
|
|
void | CreateThread (bool autoDelete=false) |
| Create a new thread defined by this class on child.
|
|
| CThread () |
| Class constructor.
|
|
bool | IsAutoDelete () const |
| Check auto delete is enabled on this thread class.
|
|
bool | IsCurrentThread () const |
| Check caller is on this running thread.
|
|
bool | IsRunning () const |
| Check thread inside this class is running and active.
|
|
bool | Join (unsigned int milliseconds) |
| The function returns when the thread execution has completed or timing is reached in milliseconds beforehand.
|
|
void | Sleep (uint32_t milliseconds) |
| Thread sleep with given amount of milliseconds.
|
|
void | StopThread (bool wait=true) |
| Stop a running thread.
|
|
virtual | ~CThread () |
| Class destructor.
|
|
|
std::atomic< bool > | m_threadStop |
| Atomic bool to indicate thread is active.
|
|
◆ Process()
|
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.
- Note
- This function is necessary and must be implemented by the addon.
Implements CThread.
The documentation for this class was generated from the following file:
- /github/workspace/xbmc/addons/kodi-dev-kit/include/kodi/tools/Timer.h