object.h File Reference

This header file provides the Object Services API. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/object.h>

Go to the source code of this file.

Data Structures
struct	rtems_object_api_class_information
	This structure is used to return information to the application about the objects configured for a specific API/Class combination. More...

Macros
#define	RTEMS_OBJECT_ID_FINAL   OBJECTS_ID_FINAL
	This constant represents the highest object identifier value.
#define	RTEMS_OBJECT_ID_FINAL_INDEX   OBJECTS_ID_FINAL_INDEX
	This constant represents the highest value for the index component of an object identifier.
#define	RTEMS_OBJECT_ID_INITIAL(_api, _class, _node)    OBJECTS_ID_INITIAL( _api, _class, _node )
	Builds the object identifier with the lowest index from the API, class, and MPCI node components.
#define	RTEMS_OBJECT_ID_INITIAL_INDEX   OBJECTS_ID_INITIAL_INDEX
	This constant represents the lowest value for the index component of an object identifier.
#define	RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
	This constant indicates that an object name to identifier search should search through all MPCI nodes of the system.
#define	RTEMS_SEARCH_LOCAL_NODE   OBJECTS_SEARCH_LOCAL_NODE
	This constant indicates that an object name to identifier search should search only the local MPCI node of the system.
#define	RTEMS_SEARCH_OTHER_NODES   OBJECTS_SEARCH_OTHER_NODES
	This constant indicates that an object name to identifier search should search through all MPCI nodes of the system except the local node.
#define	RTEMS_WHO_AM_I   OBJECTS_WHO_AM_I
	This constant indicates that an object name to identifier search is being asked for the identifier of the currently executing task.
#define	rtems_build_id(_api, _class, _node, _index)    _Objects_Build_id( _api, _class, _node, _index )
#define	rtems_build_name(_c1, _c2, _c3, _c4)    _Objects_Build_name( _c1, _c2, _c3, _c4 )
#define	rtems_object_id_get_api(_id)   _Objects_Get_API( _id )
#define	rtems_object_id_get_class(_id)   _Objects_Get_class( _id )
#define	rtems_object_id_get_node(_id)   _Objects_Get_node( _id )
#define	rtems_object_id_get_index(_id)   _Objects_Get_index( _id )
#define	rtems_object_id_api_minimum(void)   OBJECTS_INTERNAL_API
	Gets the lowest valid value for the API component of an object identifier.
#define	rtems_object_id_api_maximum(void)   OBJECTS_APIS_LAST
	Gets the highest valid value for the API component of an object identifier.

Functions
rtems_id	rtems_build_id (uint32_t api, uint32_t the_class, uint32_t node, uint32_t index)
	Builds the object identifier from the API, class, MPCI node, and index components.
rtems_name	rtems_build_name (char c1, char c2, char c3, char c4)
	Builds the object name composed of the four characters.
rtems_status_code	rtems_object_get_classic_name (rtems_id id, rtems_name *name)
	Gets the object name associated with the object identifier.
char *	rtems_object_get_name (rtems_id id, size_t length, char *name)
	Gets the object name associated with the object identifier as a string.
rtems_status_code	rtems_object_set_name (rtems_id id, const char *name)
	Sets the object name of the object associated with the object identifier.
int	rtems_object_id_get_api (rtems_id id)
	Gets the API component of the object identifier.
int	rtems_object_id_get_class (rtems_id id)
	Gets the class component of the object identifier.
int	rtems_object_id_get_node (rtems_id id)
	Gets the MPCI node component of the object identifier.
int	rtems_object_id_get_index (rtems_id id)
	Gets the index component of the object identifier.
int	rtems_object_api_minimum_class (int api)
	Gets the lowest valid class value of the object API.
int	rtems_object_api_maximum_class (int api)
	Gets the highest valid class value of the object API.
const char *	rtems_object_get_api_name (int api)
	Gets a descriptive name of the object API.
const char *	rtems_object_get_api_class_name (int the_api, int the_class)
	Gets a descriptive name of the object class of the object API.
rtems_status_code	rtems_object_get_class_information (int the_api, int the_class, rtems_object_api_class_information *info)
	Gets the object class information of the object class of the object API.

Detailed Description

This header file provides the Object Services API.