RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #20459 from benpicco/event_periodic_callback_create

Browse Source 
event_periodic_callback: add event_periodic_callback_create()
This commit is contained in:
mguetschow 2024-03-18 15:03:17 +00:00 committed by GitHub
commit 3aaea1a74e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
sys/include/event/periodic_callback.h
View File

@ -54,7 +54,7 @@ static inline void *event_periodic_callback_get_arg(event_periodic_callback_t *e
/**
* @brief Initialize a periodic callback event
*
* @note: On init the periodic event is to to run forever.
* @note: On init the periodic event is configured to run forever.
*
* @param[in] event event_periodic_callback object to initialize
* @param[in] clock the clock to configure this timer on
@ -97,6 +97,28 @@ static inline void event_periodic_callback_start(event_periodic_callback_t *even
event_periodic_start(&event->periodic, interval);
}
/**
* @brief Initialize and start a periodic callback event
*
* This is a convenience function that combines @ref event_periodic_callback_init
* and @ref event_periodic_callback_start
*
* @param[out] event event_periodic_callback object to initialize
* @param[in] clock the clock to configure this timer on
* @param[in] interval period length for the event
* @param[in] queue queue that the timed-out event will be added to
* @param[in] callback callback to set up
* @param[in] arg callback argument to set up
*/
static inline void event_periodic_callback_create(event_periodic_callback_t *event,
ztimer_clock_t *clock, uint32_t interval,
event_queue_t *queue,
void (*callback)(void *), void *arg)
{
event_periodic_callback_init(event, clock, queue, callback, arg);
event_periodic_callback_start(event, interval);
}
/**
* @brief Get the interval in which the periodic callback event repeats
*