OsTimerApi Class Reference
Implements common system callback timer API. More...
#include <SimpleTimer.h>
Inheritance diagram for OsTimerApi:
Collaboration diagram for OsTimerApi:
Public Types | |
using | Clock = OsTimerClock |
using | TickType = uint32_t |
using | TimeType = uint32_t |
Public Member Functions | |
bool | isArmed () const |
TickType | ticks () const |
~OsTimerApi () | |
void | setCallback (TimerCallback callback, void *arg) |
void | setInterval (TickType interval) |
TickType | getInterval () const |
void | arm (bool repeating) |
void | disarm () |
![]() | |
CallbackTimerApi () | |
CallbackTimerApi (const CallbackTimerApi &)=delete | |
String | name () const |
String | toString () const |
operator String () const | |
Static Public Member Functions | |
static constexpr const char * | typeName () |
static constexpr TickType | minTicks () |
static constexpr TickType | maxTicks () |
![]() | |
static constexpr const char * | typeName () |
Detailed Description
Implements common system callback timer API.
Member Typedef Documentation
◆ Clock
using OsTimerApi::Clock = OsTimerClock |
◆ TickType
using OsTimerApi::TickType = uint32_t |
◆ TimeType
using OsTimerApi::TimeType = uint32_t |
Constructor & Destructor Documentation
◆ ~OsTimerApi()
|
inline |
Member Function Documentation
◆ arm()
|
inline |
◆ disarm()
|
inline |
◆ getInterval()
|
inline |
◆ isArmed()
|
inline |
◆ maxTicks()
|
inlinestaticconstexpr |
◆ minTicks()
|
inlinestaticconstexpr |
◆ setCallback()
|
inline |
◆ setInterval()
|
inline |
◆ ticks()
|
inline |
◆ typeName()
|
inlinestaticconstexpr |
The documentation for this class was generated from the following file: