NAME

ktimer, ke_timer_init, ke_timer_set, ke_timer_cancel — dispatcher timer object

SYNOPSIS

#include <kdk/kern.h>

void
ke_timer_init(ktimer_t *timer);

void
ke_timer_set(ktimer_t *timer, uint64_t nanosecs);

void
ke_timer_cancel(ktimer_t *timer);

DESCRIPTION

The dispatcher timer object is a dispatcher object that can be waited on by ke_wait(9), defined by the ktimer_t type.

The timer object is an object that can be set to expire at a certain time in the future. When the timer expires, it becomes signalled and waiters are awoken, then the timer is disabled again and set non-signalled.

The ke_timer_init() function initialises a timer object.

The ke_timer_set() function sets the timer to expire at the time specified by the nanosecs parameter.

If the timer is already set, an attempt will be made to cancel the timer. If it cannot be cancelled, which means the timer is currently becoming signalled, the function will spin for a short time until the signalling is complete, and then the timer will be set to the new value.

The ke_timer_cancel() function tries to cancel the timer. If the timer is already in the process of becoming signalled, the function will spin for a short time until the signalling is complete, and then the timer will be cancelled.

CONTEXT

All these functions may be called from any context at or below kIPLDPC.

CODE REFERENCES

These functions are implemented in kernel/kern/timer.c.

Additional logic for the timer is implemented in kernel/kern/clock.c.

The interface is declared in kernel/include/kdk/kern.h.

SEE ALSO

ke_wait(9),

HISTORY

These interfaces have always been in Keyronex.