RTEMS Logo

RTEMS 4.9.2 On-Line Library


Timer Manager TIMER_FIRE_WHEN - Fire timer when specified

PREV UP NEXT Bookshelf RTEMS Ada User's Guide

8.4.6: TIMER_FIRE_WHEN - Fire timer when specified

CALLING SEQUENCE:

procedure Timer_Fire_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

DESCRIPTION:

This directive initiates the timer specified by id. 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.


PREV UP NEXT Bookshelf RTEMS Ada User's Guide

Copyright © 1988-2008 OAR Corporation