Simplified XF 1.1.0
Classes
IDF STM32 Port Classes
Collaboration diagram for IDF STM32 Port Classes:

Classes

class  XFEventQueue
 Default Qt implementation for the XFEventQueue interface. More...
 
class  XFMutex
 Default Qt implementation for the XFMutex interface. More...
 
void XF_tick ()
 Must be called regularly in a timer ISR or software timer callback. More...
 
int32_t XF_tickIntervalInMilliseconds ()
 
bool XF_isRunning ()
 

Detailed Description

XF port classes for the IDF STM32 port.

Function Documentation

◆ XF_isRunning()

bool XF_isRunning ( )

C function wrapping to XF::isRunning() method.

◆ XF_tick()

void XF_tick ( )

Must be called regularly in a timer ISR or software timer callback.

Following functions need to have "C" signature as they can be called in C (and C++).

The XF_tick() function must be called with the same interval given to the TimeoutManager (tickInterval).

SysTick_Handler() function is already implemented in the STM32CubeMX generated code (see Src/stm32fxxx_it.c file). Therefore, we must provide here a function which can be explicitly called in SysTick_Handler() to tick the XF.

◆ XF_tickIntervalInMilliseconds()

int32_t XF_tickIntervalInMilliseconds ( )

C function returning the tick interval in milliseconds with which the XF_tick() function should be called. This is the parameter given to the XF::init() method and may be different for each project.

C function wrapping getTickInterval() method of XFTimeoutManager.