Object Services

RTEMS provides a collection of services to assist in the management and usage of the objects created and utilized via other managers. These services assist in the manipulation of RTEMS objects independent of the API used to create them. More...

Files
file	object.h
	This header file defines the Object Manager API.

Classes
struct	rtems_object_api_class_information
	% More...

Macros
#define	rtems_build_id(_api, _class, _node, _index)   _Objects_Build_id( _api, _class, _node, _index )
	% More...
#define	rtems_build_name(_C1, _C2, _C3, _C4)   _Objects_Build_name( _C1, _C2, _C3, _C4 )
	% More...
#define	rtems_object_id_api_maximum()   OBJECTS_APIS_LAST
	%
#define	rtems_object_id_api_minimum()   OBJECTS_INTERNAL_API
	%
#define	RTEMS_OBJECT_ID_FINAL   OBJECTS_ID_FINAL
	%
#define	RTEMS_OBJECT_ID_FINAL_INDEX   OBJECTS_ID_FINAL_INDEX
	%
#define	rtems_object_id_get_api(_id)   _Objects_Get_API( _id )
	% More...
#define	rtems_object_id_get_class(_id)   _Objects_Get_class( _id )
	% More...
#define	rtems_object_id_get_index(_id)   _Objects_Get_index( _id )
	% More...
#define	rtems_object_id_get_node(_id)   _Objects_Get_node( _id )
	% More...
#define	RTEMS_OBJECT_ID_INITIAL(_api, _class, _node)   OBJECTS_ID_INITIAL( _api, _class, _node )
	% More...
#define	RTEMS_OBJECT_ID_INITIAL_INDEX   OBJECTS_ID_INITIAL_INDEX
	%
#define	RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
	%
#define	RTEMS_SEARCH_LOCAL_NODE   OBJECTS_SEARCH_LOCAL_NODE
	%
#define	RTEMS_SEARCH_OTHER_NODES   OBJECTS_SEARCH_OTHER_NODES
	%
#define	RTEMS_WHO_AM_I   OBJECTS_WHO_AM_I
	%

Functions
int	rtems_object_api_maximum_class (int api)
	% More...
int	rtems_object_api_minimum_class (int api)
	% More...
const char *	rtems_object_get_api_class_name (int the_api, int the_class)
	% More...
const char *	rtems_object_get_api_name (int api)
	% More...
rtems_status_code	rtems_object_get_class_information (int the_api, int the_class, rtems_object_api_class_information *info)
	% More...
rtems_status_code	rtems_object_get_classic_name (rtems_id id, rtems_name *name)
	% More...
static uint16_t	rtems_object_get_local_node (void)
	%
char *	rtems_object_get_name (rtems_id id, size_t length, char *name)
	% More...
int	rtems_object_id_api_maximum_class (int api)
	% More...
rtems_status_code	rtems_object_set_name (rtems_id id, const char *name)
	% More...

Detailed Description

RTEMS provides a collection of services to assist in the management and usage of the objects created and utilized via other managers. These services assist in the manipulation of RTEMS objects independent of the API used to create them.

Macro Definition Documentation

rtems_build_id

#define rtems_build_id	(		_api,
			_class,
			_node,
			_index
	)		_Objects_Build_id( _api, _class, _node, _index )

%

Parameters

_api	%
_class	%
_node	%
_index	%

Definition at line 161 of file object.h.

rtems_build_name

#define rtems_build_name	(		_C1,
			_C2,
			_C3,
			_C4
	)		_Objects_Build_name( _C1, _C2, _C3, _C4 )

%

Parameters

_C1	%
_C2	%
_C3	%
_C4	%

Definition at line 179 of file object.h.

rtems_object_id_get_api

#define rtems_object_id_get_api

(

_id

)

_Objects_Get_API( _id )

%

Parameters

_id

%

Definition at line 324 of file object.h.

rtems_object_id_get_class

#define rtems_object_id_get_class

(

_id

)

_Objects_Get_class( _id )

%

Parameters

_id

%

Definition at line 335 of file object.h.

rtems_object_id_get_index

#define rtems_object_id_get_index

(

_id

)

_Objects_Get_index( _id )

%

Parameters

_id

%

Definition at line 346 of file object.h.

rtems_object_id_get_node

#define rtems_object_id_get_node

(

_id

)

_Objects_Get_node( _id )

%

Parameters

_id

%

Definition at line 357 of file object.h.

RTEMS_OBJECT_ID_INITIAL

#define RTEMS_OBJECT_ID_INITIAL	(		_api,
			_class,
			_node
	)		OBJECTS_ID_INITIAL( _api, _class, _node )

%

Parameters

_api	%
_class	%
_node	%

Definition at line 372 of file object.h.

Function Documentation

rtems_object_api_maximum_class()

int rtems_object_api_maximum_class

(

int

api

)

%

Parameters

api

%

rtems_object_api_minimum_class()

int rtems_object_api_minimum_class

(

int

api

)

%

Parameters

api

%

rtems_object_get_api_class_name()

const char* rtems_object_get_api_class_name	(	int	the_api,
		int	the_class
	)

%

Parameters

the_api	%
the_class	%

rtems_object_get_api_name()

const char* rtems_object_get_api_name

(

int

api

)

%

Parameters

api

%

rtems_object_get_class_information()

rtems_status_code rtems_object_get_class_information	(	int	the_api,
		int	the_class,
		rtems_object_api_class_information *	info
	)

%

Parameters

the_api	%
the_class	%
info	%

rtems_object_get_classic_name()

rtems_status_code rtems_object_get_classic_name	(	rtems_id	id,
		rtems_name *	name
	)

%

Parameters

id	%
name	%

rtems_object_get_name()

char* rtems_object_get_name	(	rtems_id	id,
		size_t	length,
		char *	name
	)

%

Parameters

id	%
length	%
name	%

rtems_object_id_api_maximum_class()

int rtems_object_id_api_maximum_class

(

int

api

)

%

Parameters

api

%

rtems_object_set_name()

rtems_status_code rtems_object_set_name	(	rtems_id	id,
		const char *	name
	)

%

Parameters

id	%
name	%