Skip to content
Snippets Groups Projects
Unverified Commit f61dbb6b authored by Gaëtan Harter's avatar Gaëtan Harter
Browse files

sys/trickle: document time interval unit 'ms'

parent 9ecde3b5
No related branches found
No related tags found
No related merge requests found
...@@ -49,11 +49,12 @@ typedef struct { ...@@ -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); ...@@ -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,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment