Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
trickle.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2016 Intel Corporation
9 *
10 * SPDX-License-Identifier: Apache-2.0
11 */
12
13#ifndef ZEPHYR_INCLUDE_NET_TRICKLE_H_
14#define ZEPHYR_INCLUDE_NET_TRICKLE_H_
15
16#include <stdbool.h>
17#include <zephyr/types.h>
18
19#include <zephyr/kernel.h>
20#include <zephyr/net/net_core.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
35struct net_trickle;
36
47typedef void (*net_trickle_cb_t)(struct net_trickle *trickle,
48 bool do_suppress, void *user_data);
49
71
73#define NET_TRICKLE_INFINITE_REDUNDANCY 0
86int net_trickle_create(struct net_trickle *trickle,
87 uint32_t Imin,
88 uint8_t Imax,
89 uint8_t k);
90
101int net_trickle_start(struct net_trickle *trickle,
103 void *user_data);
104
112int net_trickle_stop(struct net_trickle *trickle);
113
121
129
137static inline bool net_trickle_is_running(struct net_trickle *trickle)
138{
139 NET_ASSERT(trickle);
140
141 return trickle->I != 0U;
142}
143
148#ifdef __cplusplus
149}
150#endif
151
152#endif /* ZEPHYR_INCLUDE_NET_TRICKLE_H_ */
int net_trickle_start(struct net_trickle *trickle, net_trickle_cb_t cb, void *user_data)
Start a Trickle timer.
int net_trickle_stop(struct net_trickle *trickle)
Stop a Trickle timer.
static bool net_trickle_is_running(struct net_trickle *trickle)
Check if the Trickle timer is running or not.
Definition trickle.h:137
int net_trickle_create(struct net_trickle *trickle, uint32_t Imin, uint8_t Imax, uint8_t k)
Create a Trickle timer.
void net_trickle_consistency(struct net_trickle *trickle)
To be called by the protocol handler when it hears a consistent network transmission.
void net_trickle_inconsistency(struct net_trickle *trickle)
To be called by the protocol handler when it hears an inconsistent network transmission.
void(* net_trickle_cb_t)(struct net_trickle *trickle, bool do_suppress, void *user_data)
Trickle timer callback.
Definition trickle.h:47
Public kernel APIs.
Network core definitions.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
A structure used to submit work after a delay.
Definition kernel.h:3985
The variable names are taken directly from RFC 6206 when applicable.
Definition trickle.h:55
uint8_t Imax
Max number of doublings.
Definition trickle.h:60
bool double_to
Flag telling if the internval is doubled.
Definition trickle.h:65
struct k_work_delayable timer
Internal timer struct.
Definition trickle.h:67
void * user_data
User specific opaque data.
Definition trickle.h:69
uint32_t I
Current interval size.
Definition trickle.h:56
net_trickle_cb_t cb
Callback to be called when timer expires.
Definition trickle.h:68
uint8_t k
Redundancy constant.
Definition trickle.h:62
uint8_t c
Consistency counter.
Definition trickle.h:63
uint32_t Istart
Start of the interval in ms.
Definition trickle.h:58
uint32_t Imin
Min interval size in ms.
Definition trickle.h:57
uint32_t Imax_abs
Max interval size in ms (not doublings)
Definition trickle.h:59