ZNC  trunk
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CFPTimer Class Reference

#include <Modules.h>

+ Inheritance diagram for CFPTimer:
+ Collaboration diagram for CFPTimer:

Public Member Functions

 CFPTimer (CModule *pModule, unsigned int uInterval, unsigned int uCycles, const CString &sLabel, const CString &sDescription)
 
virtual ~CFPTimer ()
 
void SetFPCallback (FPTimer_t p)
 
void SetModule (CModule *p)
 
void SetDescription (const CString &s)
 
CModuleGetModule () const
 
const CStringGetDescription () const
 
void run (timeval &tNow)
 This is used by the Job Manager, and not you directly. More...
 
void StartMaxCycles (double dTimeSequence, uint32_t iMaxCycles)
 
void StartMaxCycles (const timeval &tTimeSequence, uint32_t iMaxCycles)
 
void Start (double dTimeSequence)
 starts and runs infinity amount of times More...
 
void Start (const timeval &TimeSequence)
 
void Stop ()
 call this to turn off your cron, it will be removed More...
 
void Pause ()
 pauses excution of your code in RunJob More...
 
void UnPause ()
 removes the pause on RunJon More...
 
void Reset ()
 reset the timer More...
 
timeval GetInterval () const
 
uint32_t GetMaxCycles () const
 
uint32_t GetCyclesLeft () const
 
bool isValid () const
 returns true if cron is active More...
 
const CS_STRINGGetName () const
 
void SetName (const CS_STRING &sName)
 
timeval GetNextRun () const
 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 More...
 

Protected Member Functions

void RunJob () override
 this is the method you should override More...
 

Protected Attributes

CModulem_pModule
 
CString m_sDescription
 
bool m_bRunOnNextCall
 if set to true, RunJob() gets called on next invocation of run() despite the timeout More...
 

Constructor & Destructor Documentation

◆ CFPTimer()

CFPTimer::CFPTimer ( CModule pModule,
unsigned int  uInterval,
unsigned int  uCycles,
const CString sLabel,
const CString sDescription 
)
inline

◆ ~CFPTimer()

virtual CFPTimer::~CFPTimer ( )
inlinevirtual

Member Function Documentation

◆ GetCyclesLeft()

uint32_t CCron::GetCyclesLeft ( ) const
inherited

◆ GetDescription()

const CString& CTimer::GetDescription ( ) const
inherited

◆ GetInterval()

timeval CCron::GetInterval ( ) const
inherited

◆ GetMaxCycles()

uint32_t CCron::GetMaxCycles ( ) const
inherited

◆ GetModule()

CModule* CTimer::GetModule ( ) const
inherited

◆ GetName()

const CS_STRING& CCron::GetName ( ) const
inherited

◆ 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

◆ Pause()

void CCron::Pause ( )
inherited

pauses excution of your code in RunJob

◆ Reset()

void CCron::Reset ( )
inherited

reset the timer

◆ run()

void CCron::run ( timeval &  tNow)
inherited

This is used by the Job Manager, and not you directly.

◆ RunJob()

void CFPTimer::RunJob ( )
inlineoverrideprotectedvirtual

this is the method you should override

Reimplemented from CCron.

◆ SetDescription()

void CTimer::SetDescription ( const CString s)
inherited

◆ SetFPCallback()

void CFPTimer::SetFPCallback ( FPTimer_t  p)
inline

◆ SetModule()

void CTimer::SetModule ( CModule p)
inherited

◆ SetName()

void CCron::SetName ( const CS_STRING sName)
inherited

◆ Start() [1/2]

void CCron::Start ( double  dTimeSequence)
inherited

starts and runs infinity amount of times

◆ Start() [2/2]

void CCron::Start ( const timeval &  TimeSequence)
inherited

◆ StartMaxCycles() [1/2]

void CCron::StartMaxCycles ( double  dTimeSequence,
uint32_t  iMaxCycles 
)
inherited
Parameters
TimeSequencehow often to run in seconds
iMaxCycleshow many times to run, 0 makes it run forever

◆ StartMaxCycles() [2/2]

void CCron::StartMaxCycles ( const timeval &  tTimeSequence,
uint32_t  iMaxCycles 
)
inherited

◆ Stop()

void CCron::Stop ( )
inherited

call this to turn off your cron, it will be removed

◆ UnPause()

void CCron::UnPause ( )
inherited

removes the pause on RunJon

Member Data Documentation

◆ m_bRunOnNextCall

bool CCron::m_bRunOnNextCall
protectedinherited

if set to true, RunJob() gets called on next invocation of run() despite the timeout

◆ m_pModule

CModule* CTimer::m_pModule
protectedinherited

◆ m_sDescription

CString CTimer::m_sDescription
protectedinherited

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