NAME

kevent, ke_event_init, ke_event_signal, ke_event_is_signalled, ke_event_clear — dispatcher event object

SYNOPSIS

#include <kdk/kern.h>

void
ke_event_init(kevent_t *ev, bool signalled);

void
ke_event_signal(kevent_t *ev);

bool
ke_event_is_signalled(kevent_t *ev);

bool
ke_event_clear(kevent_t *ev);

DESCRIPTION

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

The event object is in one of two states: signalled or not signalled. While an event object is signalled, it can be acquired by a waiter. The object remains signalled until it is explicitly cleared.

The ke_event_init() function initialises an event object, setting its signal state to the value specified by the signalled parameter.

The ke_event_signal() function sets the signal state of the event object to signalled.

The ke_event_is_signalled() function returns the signal state of the event object.

The ke_event_clear() function sets the signal state of the event object to not signalled.

CONTEXT

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

CODE REFERENCES

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

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

HISTORY

These interfaces have always been in Keyronex.