Home2L - C/C++ API v1.4-0-g38cc (2024-05-25)
Smart Tools for a Private Home
Public Member Functions | List of all members
CRcEventTimer Class Reference

Description

Timer that sends 'rceTimer' events over the event system.

Definition at line 1840 of file resources.H.

#include "resources.H"

Inheritance diagram for CRcEventTimer:
Inheritance graph
[legend]

Public Member Functions

void Set (void *_data)
 Setup timer without (re-)scheduling it.
 
void Set (TTicks _time, TTicks _interval=0, void *_data=NULL)
 Setup and (re-)schedule timer (see CTimer::Set() ).
 
virtual void OnTime ()
 [T:timer] Virtual function called when the timer triggers.
 
virtual const char * TypeId ()
 (optional) Hint for the main event loop: object type
 
virtual const char * InstId ()
 (optional) Hint for the main event loop: object instance
 
- Public Member Functions inherited from CTimer
 CTimer (FTimerCallback *_func, void *_data=NULL, void *_creator=NULL)
 Construct with a callback function.
 
 CTimer (TTicks _time, TTicks _interval=0, FTimerCallback *_func=NULL, void *_data=NULL, void *_creator=NULL)
 Construct with a time/interval specification and eventually a callback function.
 
void Set (FTimerCallback *_func, void *_data=NULL, void *_creator=NULL)
 Setup timer without (re-)scheduling it.
 
void Set (TTicks _time, TTicks _interval=0, FTimerCallback *_func=NULL, void *_data=NULL, void *_creator=NULL)
 Setup and (re-)schedule timer. More...
 
void Reschedule (TTicks _time, TTicks _interval=0)
 Change a timer (like 'Set'), but leave function and creator unchanged.
 
void Clear ()
 Remove timer from the event list.
 
bool Pending ()
 Indicate whether the timer is pending and may be executed in the future. More...
 
virtual void OnTime ()
 [T:timer] Virtual function called when the timer triggers.
 
- Public Member Functions inherited from CRcEventProcessor
void PutEvent (CRcEvent *ev)
 Enqueue/process an event; caller remains owner of 'ev'.
 
bool PollEvent (CRcEvent *ev)
 Check for an event (non-blocking) and return it at '*ev'. More...
 
bool WaitEvent (CRcEvent *ev, TTicks *maxTime=NULL)
 Wait for an event and return it at '*ev'. More...
 
void Interrupt ()
 Request a running WaitEvent() to stop now.
 
void FlushEvents ()
 Remove all presently queued events; also waits until a concurrently running OnEvent() invocation returns.
 
virtual bool OnEvent (CRcEvent *ev)
 Handle an event asynchronously (may have been called from any thread) More...
 
void SetCbOnEvent (FRcEventFunc *_cbEvent, void *_cbEventData=NULL)
 
void ClearCbOnEvent ()
 
void SetInSelectSet (bool _inSelectSet)
 Set whether or not the event processor is contained in the set of upcoming Select() operations.
 
bool InSelectSet ()
 
const char * ToStr (CString *ret)
 

Additional Inherited Members

- Static Public Member Functions inherited from CTimer
static void DelByCreator (void *_creator)
 Remove all timers created by _creator from the event list.
 
- Static Public Member Functions inherited from CRcEventProcessor
static CRcEventProcessorSelect (TTicks maxTime=-1)
 Wait until any of the existing 'CRcEventProcessor' objects has an event available. More...
 

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