Timer Manager

The Timer Manager provides support for timer facilities. More...

Files
file	timer.h
	This header file defines the Timer Manager API.

Classes
struct	rtems_timer_information
	% More...

Macros
#define	TIMER_CLASS_BIT_TIME_OF_DAY   0x1
	%
#define	TIMER_CLASS_BIT_ON_TASK   0x2
	%
#define	TIMER_CLASS_BIT_NOT_DORMANT   0x4
	%
#define	RTEMS_TIMER_SERVER_DEFAULT_PRIORITY   ( (rtems_task_priority) -1 )
	%

Typedefs
typedef void	rtems_timer_service_routine
	%
typedef rtems_timer_service_routine(*	rtems_timer_service_routine_entry) (rtems_id, void *)
	%

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 }
	% More...

Functions
rtems_status_code	rtems_timer_cancel (rtems_id id)
	% More...
rtems_status_code	rtems_timer_create (rtems_name name, rtems_id *id)
	% More...
rtems_status_code	rtems_timer_delete (rtems_id id)
	% More...
rtems_status_code	rtems_timer_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
	% More...
rtems_status_code	rtems_timer_fire_when (rtems_id id, rtems_time_of_day *wall_time, rtems_timer_service_routine_entry routine, void *user_data)
	% More...
rtems_status_code	rtems_timer_get_information (rtems_id id, rtems_timer_information *the_info)
	% More...
rtems_status_code	rtems_timer_ident (rtems_name name, rtems_id *id)
	Identifies a timer object by the specified object name. More...
rtems_status_code	rtems_timer_initiate_server (rtems_task_priority priority, size_t stack_size, rtems_attribute attribute_set)
	% More...
rtems_status_code	rtems_timer_reset (rtems_id id)
	% More...
rtems_status_code	rtems_timer_server_fire_after (rtems_id id, rtems_interval ticks, rtems_timer_service_routine_entry routine, void *user_data)
	% More...
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)
	% More...

Detailed Description

The Timer Manager provides support for timer facilities.

Enumeration Type Documentation

Timer_Classes

enum Timer_Classes

%

Enumerator
TIMER_DORMANT	%
TIMER_INTERVAL	%
TIMER_INTERVAL_ON_TASK	%
TIMER_TIME_OF_DAY	%
TIMER_TIME_OF_DAY_ON_TASK	%

Definition at line 120 of file timer.h.

Function Documentation

rtems_timer_cancel()

rtems_status_code rtems_timer_cancel

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 19 of file timercancel.c.

rtems_timer_create()

rtems_status_code rtems_timer_create	(	rtems_name	name,
		rtems_id *	id
	)

%

Parameters

name	%
id	%

Definition at line 185 of file timercreate.c.

rtems_timer_delete()

rtems_status_code rtems_timer_delete

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 23 of file timerdelete.c.

rtems_timer_fire_after()

rtems_status_code rtems_timer_fire_after	(	rtems_id	id,
		rtems_interval	ticks,
		rtems_timer_service_routine_entry	routine,
		void *	user_data
	)

%

Parameters

id	%
ticks	%
routine	%
user_data	%

Definition at line 23 of file timerfireafter.c.

rtems_timer_fire_when()

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

%

Parameters

id	%
wall_time	%
routine	%
user_data	%

rtems_timer_get_information()

rtems_status_code rtems_timer_get_information	(	rtems_id	id,
		rtems_timer_information *	the_info
	)

%

Parameters

id	%
the_info	%

rtems_timer_ident()

rtems_status_code rtems_timer_ident	(	rtems_name	name,
		rtems_id *	id
	)

Identifies a timer object by the specified object name.

This directive obtains the timer identifier associated with the timer name specified in name.

If the timer name is not unique, then the timer identifier will match the first timer with that name in the search order. However, this timer identifier is not guaranteed to correspond to the desired timer. The timer identifier is used with other timer related directives to access the timer.

The objects are searched from lowest to the highest index. Only the local node is searched.

Parameters

	name	is the object name to look up.
[out]	id	is the pointer to an object identifier variable. The object identifier of an object with the specified name will be stored in this variable, in case of a successful operation.

Return values

RTEMS_SUCCESSFUL	The requested operation was successful.
RTEMS_INVALID_ADDRESS	The id parameter was NULL.
RTEMS_INVALID_NAME	The name parameter was 0.
RTEMS_INVALID_NAME	There was no object with the specified name on the local node.

Definition at line 44 of file timerident.c.

rtems_timer_initiate_server()

rtems_status_code rtems_timer_initiate_server	(	rtems_task_priority	priority,
		size_t	stack_size,
		rtems_attribute	attribute_set
	)

%

Parameters

priority	%
stack_size	%
attribute_set	%

rtems_timer_reset()

rtems_status_code rtems_timer_reset

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 24 of file timerreset.c.

rtems_timer_server_fire_after()

rtems_status_code rtems_timer_server_fire_after	(	rtems_id	id,
		rtems_interval	ticks,
		rtems_timer_service_routine_entry	routine,
		void *	user_data
	)

%

Parameters

id	%
ticks	%
routine	%
user_data	%

rtems_timer_server_fire_when()

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
	)

%

Parameters

id	%
wall_time	%
routine	%
user_data	%