RTEMS 4.9.4 On-Line Library

Timer Manager TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified

RTEMS C User's Guide

8.4.9: TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified

CALLING SEQUENCE:

rtems_status_code rtems_timer_server_fire_when(
  rtems_id                           id,
  rtems_time_of_day                 *wall_time,
  rtems_timer_service_routine_entry  routine,
  void                              *user_data
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - timer initiated successfully
RTEMS_INVALID_ADDRESS - routine is NULL
RTEMS_INVALID_ADDRESS - wall_time is NULL
RTEMS_INVALID_ID - invalid timer id
RTEMS_NOT_DEFINED - system date and time is not set
RTEMS_INVALID_CLOCK - invalid time of day
RTEMS_INCORRECT_STATE - Timer Server not initiated

DESCRIPTION:

This directive initiates the timer specified by id and specifies that when it fires it will be executed by the Timer Server.

If the timer is running, it is automatically canceled before being initiated. The timer is scheduled to fire at the time of day specified by wall_time. When the timer fires, the timer service routine routine will be invoked with the argument user_data.

NOTES:

This directive will not cause the running task to be preempted.

RTEMS C User's Guide