Contiki-NG
|
The ctimer module provides a timer mechanism that calls a specified C function when a ctimer expires. More...
Functions | |
void | ctimer_init (void) |
Initialize the callback timer library. More... | |
void | ctimer_set (struct ctimer *c, clock_time_t t, void(*f)(void *), void *ptr) |
Set a callback timer. More... | |
void | ctimer_set_with_process (struct ctimer *c, clock_time_t t, void(*f)(void *), void *ptr, struct process *p) |
Set a callback timer. More... | |
void | ctimer_reset (struct ctimer *c) |
Reset a callback timer with the same interval as was previously set. More... | |
void | ctimer_restart (struct ctimer *c) |
Restart a callback timer from the current point in time. More... | |
void | ctimer_stop (struct ctimer *c) |
Stop a pending callback timer. More... | |
int | ctimer_expired (struct ctimer *c) |
Check if a callback timer has expired. More... | |
The ctimer module provides a timer mechanism that calls a specified C function when a ctimer expires.
It is not safe to manipulate callback timers within an interrupt context.
int ctimer_expired | ( | struct ctimer * | c | ) |
Check if a callback timer has expired.
c | A pointer to the callback timer |
This function tests if a callback timer has expired and returns true or false depending on its status.
Definition at line 161 of file ctimer.c.
Referenced by rpl_timers_schedule_periodic_dis().
void ctimer_init | ( | void | ) |
void ctimer_reset | ( | struct ctimer * | c | ) |
Reset a callback timer with the same interval as was previously set.
c | A pointer to the callback timer. This function resets the callback timer with the same interval that was given to the callback timer with the ctimer_set() function. The start point of the interval is the exact time that the callback timer last expired. Therefore, this function will cause the timer to be stable over time, unlike the ctimer_restart() function. If this is executed before the timer expired, this function has no effect. |
void ctimer_restart | ( | struct ctimer * | c | ) |
Restart a callback timer from the current point in time.
c | A pointer to the callback timer. This function restarts the callback timer with the same interval that was given to the ctimer_set() function. The callback timer will start at the current time. \note A periodic timer will drift if this function is used to reset it. For periodic timers, use the ctimer_reset() function instead. |
void ctimer_set | ( | struct ctimer * | c, |
clock_time_t | t, | ||
void(*)(void *) | f, | ||
void * | ptr | ||
) |
Set a callback timer.
c | A pointer to the callback timer. |
t | The interval before the timer expires. |
f | A function to be called when the timer expires. |
ptr | An opaque pointer that will be supplied as an argument to the callback function. This function is used to set a callback timer for a time sometime in the future. When the callback timer expires, the callback function f will be called with ptr as argument. This essentially does ctimer_set_process(c, t, f, ptr, PROCESS_CURRENT()); |
Definition at line 99 of file ctimer.c.
Referenced by rpl_timers_init().
void ctimer_set_with_process | ( | struct ctimer * | c, |
clock_time_t | t, | ||
void(*)(void *) | f, | ||
void * | ptr, | ||
struct process * | p | ||
) |
Set a callback timer.
c | A pointer to the callback timer. |
t | The interval before the timer expires. |
f | A function to be called when the timer expires. |
ptr | An opaque pointer that will be supplied as an argument to the callback function. |
p | A pointer to the process the timer belongs to This function is used to set a callback timer for a time sometime in the future. When the callback timer expires, the callback function f will be called with ptr as argument. |
void ctimer_stop | ( | struct ctimer * | c | ) |
Stop a pending callback timer.
c | A pointer to the pending callback timer. This function stops a callback timer that has previously been set with ctimer_set(), ctimer_reset(), or ctimer_restart(). After this function has been called, the callback timer will be expired and will not call the callback function. |
Definition at line 149 of file ctimer.c.
Referenced by rpl_timers_stop_dag_timers().