id_wait


Description:

public static ClockReturn id_wait (ClockID id, out ClockTimeDiff jitter)

Performs a blocking wait on id.

id should have been created with new_single_shot_id or new_periodic_id and should not have been unscheduled with a call to id_unschedule.

If the jitter argument is not null and this function returns OK or EARLY, it will contain the difference against the clock and the time of id when this method was called. Positive values indicate how late id was relative to the clock (in which case this function will return EARLY). Negative values indicate how much time was spent waiting on the clock before this function returned.

Parameters:

id

The ClockID to wait on

jitter

a pointer that will contain the jitter, can be null.

Returns:

the result of the blocking wait. EARLY will be returned if the current clock time is past the time of id, OK if id was scheduled in time. UNSCHEDULED if id was unscheduled with id_unschedule.