#include <Modules.h>
◆ CTimer() [1/2]
CTimer::CTimer |
( |
CModule * | pModule, |
|
|
unsigned int | uInterval, |
|
|
unsigned int | uCycles, |
|
|
const CString & | sLabel, |
|
|
const CString & | sDescription ) |
◆ ~CTimer()
virtual CTimer::~CTimer |
( |
| ) |
|
|
virtual |
◆ CTimer() [2/2]
CTimer::CTimer |
( |
const CTimer & | | ) |
|
|
delete |
◆ GetCyclesLeft()
uint32_t CCron::GetCyclesLeft |
( |
| ) |
const |
|
inherited |
◆ GetDescription()
const CString & CTimer::GetDescription |
( |
| ) |
const |
◆ GetInterval()
timeval CCron::GetInterval |
( |
| ) |
const |
|
inherited |
◆ GetMaxCycles()
uint32_t CCron::GetMaxCycles |
( |
| ) |
const |
|
inherited |
◆ GetModule()
CModule * CTimer::GetModule |
( |
| ) |
const |
◆ GetName()
◆ GetNextRun()
timeval CCron::GetNextRun |
( |
| ) |
const |
|
inlineinherited |
returns the timestamp of the next estimated run time. Note that it may not run at this EXACT time, but it will run at least at this time or after
◆ isValid()
bool CCron::isValid |
( |
| ) |
const |
|
inherited |
returns true if cron is active
◆ operator=()
◆ Pause()
pauses excution of your code in RunJob
◆ Reset()
◆ run()
void CCron::run |
( |
timeval & | tNow | ) |
|
|
inherited |
This is used by the Job Manager, and not you directly.
◆ RunJob()
virtual void CCron::RunJob |
( |
| ) |
|
|
virtualinherited |
this is the method you should override
Reimplemented in CFPTimer.
◆ SetDescription()
void CTimer::SetDescription |
( |
const CString & | s | ) |
|
◆ SetModule()
void CTimer::SetModule |
( |
CModule * | p | ) |
|
◆ SetName()
void CCron::SetName |
( |
const CS_STRING & | sName | ) |
|
|
inherited |
◆ Start() [1/2]
void CCron::Start |
( |
const timeval & | TimeSequence | ) |
|
|
inherited |
◆ Start() [2/2]
void CCron::Start |
( |
double | dTimeSequence | ) |
|
|
inherited |
starts and runs infinity amount of times
◆ StartMaxCycles() [1/2]
void CCron::StartMaxCycles |
( |
const timeval & | tTimeSequence, |
|
|
uint32_t | iMaxCycles ) |
|
inherited |
◆ StartMaxCycles() [2/2]
void CCron::StartMaxCycles |
( |
double | dTimeSequence, |
|
|
uint32_t | iMaxCycles ) |
|
inherited |
- Parameters
-
TimeSequence | how often to run in seconds |
iMaxCycles | how many times to run, 0 makes it run forever |
◆ Stop()
call this to turn off your cron, it will be removed
◆ UnPause()
removes the pause on RunJon
◆ m_bRunOnNextCall
bool CCron::m_bRunOnNextCall |
|
protectedinherited |
if set to true, RunJob() gets called on next invocation of run() despite the timeout
◆ m_pModule
◆ m_sDescription
The documentation for this class was generated from the following file: