Symbols ![]()
loading...
Files ![]()
loading...
alarm_pool_add_alarm_in_ms() function
Add an alarm callback to be called after a delay specified in milliseconds Generally the callback is called as soon as possible after the time specified from an IRQ handler on the core the alarm pool was created on. 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
static inline alarm_id_t alarm_pool_add_alarm_in_ms(alarm_pool_t *pool,
uint32_t ms,
alarm_callback_t callback,
void *user_data,
bool fire_if_past);
Return value
>0 the alarm id 0 if the alarm time passed before or during the call and fire_if_past was false <0 if there were no alarm slots available, or other error occurred
Notes
It is safe to call this method from an IRQ handler (including alarm callbacks), and from either core.
Related Functions
Found 13 other functions taking a ![]()
alarm_pool
argument:
Function
Description
Cancel an alarm
Add an alarm callback to be called at a specific time Generally the callback is called as soon as possible after the time specified from an IRQ handler on the core the alarm pool was created on. 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.
Return the core number the alarm pool was initialized on (and hence callbacks are called on)
Add a repeating timer that is called repeatedly at the specified interval in microseconds Generally the callback is called as soon as possible after the time specified from an IRQ handler on the core the alarm pool was created on. 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.
Add an alarm callback to be called at or after a specific time The callback is called as soon as possible after the time specified from an IRQ handler on the core the alarm pool was created on. Unlike alarm_pool_add_alarm_at, this method guarantees to call the callback from that core even if the time is during this method call or in the past.
Return the time remaining before the next trigger of an alarm
Destroy the alarm pool, cancelling all alarms and freeing up the underlying timer_alarm
Return the time remaining before the next trigger of an alarm
Return the timer alarm used by an alarm pool
Add an alarm callback to be called after a delay specified in microseconds Generally the callback is called as soon as possible after the time specified from an IRQ handler on the core the alarm pool was created on. 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.
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 the alarm pool was created on. 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.