RTEMS 4.9.3 On-Line Library

Timer Manager TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified

RTEMS Ada User's Guide

8.4.9: TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified

CALLING SEQUENCE:

procedure Timer_Fire_Server_When (
   ID        : in     RTEMS.ID;
   Wall_Time : in     RTEMS.Time_Of_Day;
   Routine   : in     RTEMS.Timer_Service_Routine;
   User_Data : in     RTEMS.Address;
   Result    :    out RTEMS.Status_Codes
);

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 Ada User's Guide