add_repeating_timer_ms() function

Add a repeating timer that is called repeatedly at the specified interval in milliseconds Generally the callback is called as soon as possible after the time specified from an IRQ handler on the core of the default alarm pool (generally core 0). If the callback is in the past or happens before the alarm setup could be completed, then this method will optionally call the callback itself and then return a return code to indicate that the target time has passed.

Syntax

Show:

Summary

Declaration

from time.h:824

static inline bool add_repeating_timer_ms(int32_t delay_ms, repeating_timer_callback_t callback, void *user_data, repeating_timer_t *out);

Arguments

Argument

Declared as

Description

delay_ms

int32_t

the repeat delay in milliseconds; if >0 then this is the delay between one callback ending and the next starting; if <0 then this is the negative of the time between the starts of the callbacks. The value of 0 is treated as 1 microsecond

callback

repeating_timer_callback_t

the repeating timer callback function

user_data

void *

user data to pass to store in the repeating_timer structure for use by the callback.

out

repeating_timer_t *

the pointer to the user owned structure to store the repeating timer info in. BEWARE this storage location must outlive the repeating timer, so be careful of using stack space

Return value

false if there were no alarm slots available to create the timer, true otherwise.

Notes

It is safe to call this method from an IRQ handler (including alarm callbacks), and from either core.

Examples

add_repeating_timer_ms() is referenced by 1 libraries and example projects:

References

from examples

add_repeating_timer_ms() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle