Contiki-NG
|
The timer library provides functions for setting, resetting and restarting timers, and for checking if a timer has expired. More...
Data Structures | |
struct | timer |
A timer. More... | |
Functions | |
void | timer_set (struct timer *t, clock_time_t interval) |
Set a timer. More... | |
void | timer_reset (struct timer *t) |
Reset the timer with the same interval. More... | |
void | timer_restart (struct timer *t) |
Restart the timer from the current point in time. More... | |
int | timer_expired (struct timer *t) |
Check if a timer has expired. More... | |
clock_time_t | timer_remaining (struct timer *t) |
The time until the timer expires. More... | |
The timer library provides functions for setting, resetting and restarting timers, and for checking if a timer has expired.
An application must "manually" check if its timers have expired; this is not done automatically.
A timer is declared as a struct
timer
and all access to the timer is made by a pointer to the declared timer.
int timer_expired | ( | struct timer * | t | ) |
Check if a timer has expired.
This function tests if a timer has expired and returns true or false depending on its status.
t | A pointer to the timer |
Definition at line 123 of file timer.c.
Referenced by gpiote_event_handler().
clock_time_t timer_remaining | ( | struct timer * | t | ) |
void timer_reset | ( | struct timer * | t | ) |
Reset the timer with the same interval.
This function resets the timer with the same interval that was given to the timer_set() function. The start point of the interval is the exact time that the timer last expired. Therefore, this function will cause the timer to be stable over time, unlike the timer_restart() function. If this is executed before the timer expired, this function has no effect.
t | A pointer to the timer. |
void timer_restart | ( | struct timer * | t | ) |
Restart the timer from the current point in time.
This function restarts a timer with the same interval that was given to the timer_set() function. The timer will start at the current time.
t | A pointer to the timer. |
void timer_set | ( | struct timer * | t, |
clock_time_t | interval | ||
) |
Set a timer.
This function is used to set a timer for a time sometime in the future. The function timer_expired() will evaluate to true after the timer has expired.
t | A pointer to the timer |
interval | The interval before the timer expires. |
Definition at line 64 of file timer.c.
Referenced by gpiote_event_handler().