a752c7ab
 elopes
add first test an...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* Trickle constants and prototypes
*
* Copyright (C) 2013, 2014 INRIA.
* 2017 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup sys_trickle Trickle Timer
* @ingroup sys
* @brief Implementation of a generic Trickle Algorithm (RFC 6206)
*
* @see https://tools.ietf.org/html/rfc6206
*
* @{
*
* @file
* @brief Trickle timer interface definition
*
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Cenk Gündoğan <cenk.guendogan@haw-hamburg.de>
*/
#ifndef TRICKLE_H
#define TRICKLE_H
#ifdef __cplusplus
extern "C" {
#endif
#include "xtimer.h"
#include "thread.h"
/**
* @brief Trickle callback function with arguments
*/
typedef struct {
void (*func)(void *); /**< callback function pointer */
void *args; /**< callback function arguments */
} trickle_callback_t;
/**
* @brief all state variables of a trickle timer
*/
typedef struct {
uint8_t k; /**< redundancy constant */
uint8_t Imax; /**< maximum interval size,
described as of Imin doublings */
uint16_t c; /**< counter */
uint32_t Imin; /**< minimum interval size */
uint32_t I; /**< current interval size */
uint32_t t; /**< time within the current interval */
kernel_pid_t pid; /**< pid of trickles target thread */
trickle_callback_t callback; /**< callback function and parameter that
trickle calls after each interval */
msg_t msg; /**< the msg_t to use for intervals */
uint64_t msg_time; /**< interval in ms */
xtimer_t msg_timer; /**< xtimer to send a msg_t to the target
thread for a new interval */
} trickle_t;
/**
* @brief resets the trickle timer
*
* @pre `trickle->I > trickle->Imin`
* @see https://tools.ietf.org/html/rfc6206#section-4.2, number 6
*
* @param[in] trickle the trickle timer
*/
void trickle_reset_timer(trickle_t *trickle);
/**
* @brief start the trickle timer
*
* @pre `Imin > 0`
* @pre `(Imin << Imax) < (UINT32_MAX / 2)` to avoid overflow of uint32_t
*
* @param[in] pid target thread
* @param[in] trickle trickle timer
* @param[in] msg_type msg_t.type for messages
* @param[in] Imin minimum interval
* @param[in] Imax maximum interval
* @param[in] k redundancy constant
*/
void trickle_start(kernel_pid_t pid, trickle_t *trickle, uint16_t msg_type,
uint32_t Imin, uint8_t Imax, uint8_t k);
/**
* @brief stops the trickle timer
*
* @param[in] trickle trickle timer
*/
void trickle_stop(trickle_t *trickle);
/**
* @brief increments the counter by one
*
* @param[in] trickle trickle timer
*/
void trickle_increment_counter(trickle_t *trickle);
/**
* @brief is called after the interval is over and calculates the next interval
*
* @pre `(trickle->I > 0)` required for trickle algorithm to work
*
* @param[in] trickle trickle timer
*/
void trickle_interval(trickle_t *trickle);
/**
* @brief is called after the interval is over and executes callback function
*
* @param[in] trickle trickle timer
*/
void trickle_callback(trickle_t *trickle);
#ifdef __cplusplus
}
#endif
#endif /* TRICKLE_H */
/** @} */
|