TimerAlarmRepeatingDriverESP8266 Class Reference

Repeating Timer functions for repeated execution: Plaease use the typedef TimerAlarmRepeating. More...

#include <AudioTimerESP8266.h>

Inheritance diagram for TimerAlarmRepeatingDriverESP8266:

Public Member Functions
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
void *	callbackParameter ()
bool	end () override
void	setCallbackParameter (void *obj)
virtual void	setIsSave (bool is_save)
	Not used.
virtual void	setTimer (int timer)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Static Public Member Functions
static void	complexHandler (void *param)

Protected Member Functions
const char *	toString (TimeUnit unit)

Protected Attributes
void(*	current_timer_callback )()
void *	object = nullptr
Ticker	ticker

Detailed Description

Repeating Timer functions for repeated execution: Plaease use the typedef TimerAlarmRepeating.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin()

bool begin ( repeating_timer_callback_t  callback_f, uint32_t  time, TimeUnit  unit = MS  )

inlineoverridevirtual

Starts the alarm timer

Implements TimerAlarmRepeatingDriverBase.

callbackParameter()

void * callbackParameter ( )

inlineinherited

complexHandler()

static void complexHandler ( void *  param )

inlinestatic

We can not do any I2C calls in the interrupt handler so we need to do this in a separate task

end()

bool end ( )

inlineoverridevirtual

Reimplemented from TimerAlarmRepeatingDriverBase.

setCallbackParameter()

void setCallbackParameter ( void *  obj )

inlineinherited

setIsSave()

virtual void setIsSave ( bool  is_save )

inlinevirtualinherited

Not used.

setTimer()

virtual void setTimer ( int  timer )

inlinevirtualinherited

Reimplemented in TimerAlarmRepeatingDriverRenesas, and TimerAlarmRepeatingDriverSTM32.

setTimerFunction()

virtual void setTimerFunction ( TimerFunction  function = DirectTimerCallback )

inlinevirtualinherited

toString()

const char * toString ( TimeUnit  unit )

inlineprotectedinherited

Member Data Documentation

current_timer_callback

void(* current_timer_callback) ()

protected

object

void* object = nullptr

protectedinherited

ticker

Ticker ticker

protected

---

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

• src/AudioTools/CoreAudio/AudioTimer/AudioTimerESP8266.h