periodic_callback.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2022 ML!PA Consulting GmbH
3  * SPDX-License-Identifier: LGPL-2.1-only
4  */
5 
6 #pragma once
7 
24 #include <assert.h>
25 #include "event/callback.h"
26 #include "event/periodic.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
35 typedef struct {
39 
47 {
48  return event->event.arg;
49 }
50 
63  ztimer_clock_t *clock, event_queue_t *queue,
64  void (*callback)(void *), void *arg)
65 {
66  memset(&event->event, 0, sizeof(event->event));
67  event->event.super.handler = _event_callback_handler;
68  event->event.callback = callback;
69  event->event.arg = arg;
70 
71  event_periodic_init(&event->periodic, clock, queue, &event->event.super);
72 }
73 
92  uint32_t interval)
93 {
94  assert(event->event.callback);
95  event_periodic_start(&event->periodic, interval);
96 }
97 
112  ztimer_clock_t *clock, uint32_t interval,
113  event_queue_t *queue,
114  void (*callback)(void *), void *arg)
115 {
116  event_periodic_callback_init(event, clock, queue, callback, arg);
118 }
119 
128 {
129  return event->periodic.timer.interval;
130 }
131 
140  uint32_t count)
141 {
142  event_periodic_set_count(&event->periodic, count);
143 }
144 
153 {
154  return event->periodic.count;
155 }
156 
172 {
173  event_periodic_stop(&event->periodic);
174 }
175 
176 #ifdef __cplusplus
177 }
178 #endif
POSIX.1-2008 compliant version of the assert macro.
#define assert(cond)
abort the program if assertion is false
Definition: assert.h:143
Provides a callback-with-argument event type.
void _event_callback_handler(event_t *event)
event callback handler function (used internally)
Provides functionality to trigger periodic events.
static void event_periodic_stop(event_periodic_t *event_periodic)
Stop a periodic timeout event.
Definition: periodic.h:142
static void event_periodic_set_count(event_periodic_t *event_periodic, uint32_t count)
Set the amount of times the periodic event should repeat itself.
Definition: periodic.h:120
static void event_periodic_start(event_periodic_t *event_periodic, uint32_t interval)
Starts a periodic timeout.
Definition: periodic.h:107
void event_periodic_init(event_periodic_t *event_periodic, ztimer_clock_t *clock, event_queue_t *queue, event_t *event)
Initialize a periodic event timeout.
static void event_periodic_callback_init(event_periodic_callback_t *event, ztimer_clock_t *clock, event_queue_t *queue, void(*callback)(void *), void *arg)
Initialize a periodic callback event.
static void event_periodic_callback_stop(event_periodic_callback_t *event)
Stop a periodic callback event.
static uint32_t event_periodic_callback_get_interval(const event_periodic_callback_t *event)
Get the interval in which the periodic callback event repeats.
static void * event_periodic_callback_get_arg(event_periodic_callback_t *event)
Get user context from Periodic Callback Event.
static uint32_t event_periodic_callback_get_count(const event_periodic_callback_t *event)
Get the amount of times the periodic callback event should repeat itself.
static void event_periodic_callback_start(event_periodic_callback_t *event, uint32_t interval)
Starts a periodic callback event.
static void event_periodic_callback_set_count(event_periodic_callback_t *event, uint32_t count)
Set the amount of times the periodic callback event should repeat itself.
static 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)
Initialize and start a periodic callback event.
event queue structure
Definition: event.h:150
Callback Event structure definition.
Definition: callback.h:45
Periodic Callback Event structure.
event_callback_t event
callback event portion
event_periodic_t periodic
periodic event portion
Timeout Event structure.
Definition: periodic.h:50
event structure
Definition: event.h:142
ztimer device structure
Definition: ztimer.h:367