timer.h File Reference

This header file provides the Timer Manager API. More...

#include <stddef.h>
#include <rtems/rtems/attr.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/watchdogticks.h>

Go to the source code of this file.

Data Structures
struct	rtems_timer_information
	The structure contains information about a timer. More...

Macros
#define	TIMER_CLASS_BIT_NOT_DORMANT   0x4
	This timer class bit indicates that the timer is not dormant.
#define	TIMER_CLASS_BIT_ON_TASK   0x2
	This timer class bit indicates that the timer routine executes in a task context.
#define	TIMER_CLASS_BIT_TIME_OF_DAY   0x1
	This timer class bit indicates that the timer uses a time of day.
#define	RTEMS_TIMER_SERVER_DEFAULT_PRIORITY   ( (rtems_task_priority) -1 )
	This constant represents the default value for the task priority of the Timer Server.

Typedefs
typedef void	rtems_timer_service_routine
	This type defines the return type of routines which can be fired by directives of the Timer Manager.
typedef rtems_timer_service_routine(*	rtems_timer_service_routine_entry) (rtems_id, void *)
	This type defines the prototype of routines which can be fired by directives of the Timer Manager.

Enumerations
enum	Timer_Classes {   TIMER_DORMANT , TIMER_INTERVAL = TIMER_CLASS_BIT_NOT_DORMANT , TIMER_INTERVAL_ON_TASK , TIMER_TIME_OF_DAY ,   TIMER_TIME_OF_DAY_ON_TASK }
	The timer class indicates how the timer was most recently fired. More...

Functions
rtems_status_code	rtems_timer_get_information (rtems_id id, rtems_timer_information *the_info)
	Gets information about the timer.
rtems_status_code	rtems_timer_create (rtems_name name, rtems_id *id)
	Creates a timer.
rtems_status_code	rtems_timer_ident (rtems_name name, rtems_id *id)
	Identifies a timer by the object name.
rtems_status_code	rtems_timer_cancel (rtems_id id)
	Cancels the timer.
rtems_status_code	rtems_timer_delete (rtems_id id)
	Deletes the timer.
rtems_status_code	rtems_timer_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
	Fires the timer after the interval.
rtems_status_code	rtems_timer_fire_when (rtems_id id, const rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data)
	Fires the timer at the time of day.
rtems_status_code	rtems_timer_initiate_server (rtems_task_priority priority, size_t stack_size, rtems_attribute attribute_set)
	Initiates the Timer Server.
rtems_status_code	rtems_timer_server_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
	Fires the timer after the interval using the Timer Server.
rtems_status_code	rtems_timer_server_fire_when (rtems_id id, const rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data)
	Fires the timer at the time of day using the Timer Server.
rtems_status_code	rtems_timer_reset (rtems_id id)
	Resets the timer.

Detailed Description

This header file provides the Timer Manager API.