RTEMS 4.9.2 On-Line Library

Task Manager TASK_WAKE_WHEN - Wake up when specified

RTEMS C User's Guide

5.4.15: TASK_WAKE_WHEN - Wake up when specified

CALLING SEQUENCE:

rtems_status_code rtems_task_wake_when(
  rtems_time_of_day *time_buffer
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - awakened at date/time successfully
RTEMS_INVALID_ADDRESS - time_buffer is NULL
RTEMS_INVALID_TIME_OF_DAY - invalid time buffer
RTEMS_NOT_DEFINED - system date and time is not set

DESCRIPTION:

This directive blocks a task until the date and time specified in time_buffer. At the requested date and time, the calling task will be unblocked and made ready to execute.

NOTES:

The ticks portion of time_buffer structure is ignored. The timing granularity of this directive is a second.

A clock tick is required to support the functionality of this directive.

RTEMS C User's Guide