riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sys/trickle: document time interval unit 'ms'

Browse Source 
Unit is milliseconds as said here:

https://github.com/RIOT-OS/RIOT/pull/9145#discussion_r188861183
This commit is contained in:
Gaëtan Harter 2018-05-29 11:59:12 +02:00
parent 9ecde3b5a6
commit f61dbb6bdb
No known key found for this signature in database
GPG Key ID: 76DF6BCF1B1F883B
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
sys/include/trickle.h
View File

@ -49,11 +49,12 @@ typedef struct {
typedef struct { typedef struct {
uint8_t k; /**< redundancy constant */ uint8_t k; /**< redundancy constant */
uint8_t Imax; /**< maximum interval size, uint8_t Imax; /**< maximum interval size,
described as of Imin doublings */ described as of Imin doublings in ms */
uint16_t c; /**< counter */ uint16_t c; /**< counter */
uint32_t Imin; /**< minimum interval size */ uint32_t Imin; /**< minimum interval size in ms */
uint32_t I; /**< current interval size */ uint32_t I; /**< current interval size in ms */
uint32_t t; /**< time within the current interval */ uint32_t t; /**< time within the current interval
in ms */
kernel_pid_t pid; /**< pid of trickles target thread */ kernel_pid_t pid; /**< pid of trickles target thread */
trickle_callback_t callback; /**< callback function and parameter that trickle_callback_t callback; /**< callback function and parameter that
trickle calls after each interval */ trickle calls after each interval */
@ -81,8 +82,8 @@ void trickle_reset_timer(trickle_t *trickle);
* @param[in] pid target thread * @param[in] pid target thread
* @param[in] trickle trickle timer * @param[in] trickle trickle timer
* @param[in] msg_type msg_t.type for messages * @param[in] msg_type msg_t.type for messages
* @param[in] Imin minimum interval * @param[in] Imin minimum interval in ms
* @param[in] Imax maximum interval * @param[in] Imax maximum interval in ms
* @param[in] k redundancy constant * @param[in] k redundancy constant
*/ */
void trickle_start(kernel_pid_t pid, trickle_t *trickle, uint16_t msg_type, void trickle_start(kernel_pid_t pid, trickle_t *trickle, uint16_t msg_type,