6.16.1 osenv_sleep_init: prepare to put the current process to sleep

 

SYNOPSIS

#include <oskit/dev/dev.h>

void osenv_sleep_init(osenv_sleeprec_t *sleeprec);

DIRECTION

Component OS, Nonblocking

DESCRIPTION

This function initializes a ``sleep record'' structure in preparation for the current process's going to sleep waiting for some event to occur. The sleep record is used to avoid races between actually going to sleep and the event of interest, and to provide a ``handle'' on the current activity by which osenv_wakeup can indicate which process to awaken.

PARAMETERS

sleeprec

A pointer to the process-private sleep record.