deferred_callback.h File Reference

Trigger an event callback after a timeout. More...

Detailed Description

Trigger an event callback after a timeout.

This provides convenience functions to trigger a callback event after some time has passed.

Event Deferred Callback API

Author

Benjamin Valentin benja.nosp@m.min..nosp@m.valen.nosp@m.tin@.nosp@m.ml-pa.nosp@m..com

Definition in file deferred_callback.h.

#include <assert.h>
#include "event/callback.h"
#include "ztimer.h"

Include dependency graph for deferred_callback.h:

Go to the source code of this file.

Data Structures
struct	event_deferred_callback_t
	Deferred Callback Event structure. More...
static void	_event_deferred_post (void *arg)
	Internal helper function for ztimer callback.
static void	event_deferred_callback_post (event_deferred_callback_t *event, event_queue_t *queue, ztimer_clock_t *clock, uint32_t timeout, void(*callback)(void *), void *arg)
	Execute a callback function in the event thread after a timeout.
static void	event_deferred_callback_cancel (event_deferred_callback_t *event, ztimer_clock_t *clock)
	Cancel a callback function if it has not been executed yet.

Function Documentation

_event_deferred_post()

static void _event_deferred_post ( void * arg )

inlinestatic

Internal helper function for ztimer callback.

Parameters

[in]

arg

event structure

Definition at line 49 of file deferred_callback.h.

event_deferred_callback_cancel()

static void event_deferred_callback_cancel ( event_deferred_callback_t * event, ztimer_clock_t * clock )

inlinestatic

Cancel a callback function if it has not been executed yet.

Parameters

[in]	event	event_deferred_callback object to cancel
[in]	clock	the clock this timer runs on

Definition at line 93 of file deferred_callback.h.

event_deferred_callback_post()

static void event_deferred_callback_post ( event_deferred_callback_t * event, event_queue_t * queue, ztimer_clock_t * clock, uint32_t timeout, void(* callback )(void *), void * arg )

inlinestatic

Execute a callback function in the event thread after a timeout.

Warning

event must be kept allocated until the callback was executed

Parameters

[in]	event	event_deferred_callback object to initialize
[in]	queue	queue that the timed-out event will be added to
[in]	clock	the clock to configure this timer on
[in]	timeout	timer target (relative ticks from now)
[in]	callback	callback to set up
[in]	arg	callback argument to set up

Definition at line 68 of file deferred_callback.h.