ReactESP 1.0.0
Asynchronous programming for the ESP microcontrollers
TimedReaction Class Referenceabstract

TimedReactions are called based on elapsing of time. More...

#include <ReactESP.h>

Inheritance diagram for TimedReaction:
Collaboration diagram for TimedReaction:

Public Member Functions

 TimedReaction (const uint32_t interval, const react_callback callback)
 Construct a new Timed Reaction object. More...
 
 TimedReaction (const uint64_t interval, const react_callback callback)
 Construct a new Timed Reaction object. More...
 
virtual ~TimedReaction ()
 
bool operator< (const TimedReaction &other)
 Return the current time since the device restart in microseconds. More...
 
void add ()
 
void remove ()
 
uint32_t getTriggerTime ()
 
uint64_t getTriggerTimeMicros ()
 
bool isEnabled ()
 
virtual void tick ()=0
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 

Protected Attributes

const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from Reaction
const react_callback callback
 

Detailed Description

TimedReactions are called based on elapsing of time.

Definition at line 45 of file ReactESP.h.

Constructor & Destructor Documentation

◆ TimedReaction() [1/2]

TimedReaction::TimedReaction ( const uint32_t  interval,
const react_callback  callback 
)
inline

Construct a new Timed Reaction object.

Parameters
intervalInterval or delay for the reaction, in milliseconds
callbackFunction to be called when the reaction is triggered

Definition at line 58 of file ReactESP.h.

◆ TimedReaction() [2/2]

TimedReaction::TimedReaction ( const uint64_t  interval,
const react_callback  callback 
)
inline

Construct a new Timed Reaction object.

Parameters
intervalInterval, in microseconds
callbackFunction to be called when the reaction is triggered

Definition at line 69 of file ReactESP.h.

◆ ~TimedReaction()

virtual TimedReaction::~TimedReaction ( )
inlinevirtual

Definition at line 75 of file ReactESP.h.

Member Function Documentation

◆ add()

void TimedReaction::add ( )
virtual

Implements Reaction.

Definition at line 26 of file ReactESP.cpp.

Here is the caller graph for this function:

◆ getTriggerTime()

uint32_t TimedReaction::getTriggerTime ( )
inline

Definition at line 79 of file ReactESP.h.

◆ getTriggerTimeMicros()

uint64_t TimedReaction::getTriggerTimeMicros ( )
inline

Definition at line 80 of file ReactESP.h.

◆ isEnabled()

bool TimedReaction::isEnabled ( )
inline

Definition at line 81 of file ReactESP.h.

◆ operator<()

bool TimedReaction::operator< ( const TimedReaction other)

Return the current time since the device restart in microseconds.

Returns the time since the device restart. Even though the time is in microseconds, a 64-bit integer is all but guaranteed not to rewrap, ever.

Definition at line 21 of file ReactESP.cpp.

◆ remove()

void TimedReaction::remove ( )
virtual

Implements Reaction.

Definition at line 28 of file ReactESP.cpp.

◆ tick()

virtual void TimedReaction::tick ( )
pure virtual

Implements Reaction.

Implemented in DelayReaction, and RepeatReaction.

Member Data Documentation

◆ enabled

bool TimedReaction::enabled
protected

Definition at line 49 of file ReactESP.h.

◆ interval

const uint64_t TimedReaction::interval
protected

Definition at line 47 of file ReactESP.h.

◆ last_trigger_time

uint64_t TimedReaction::last_trigger_time
protected

Definition at line 48 of file ReactESP.h.


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