RT Run-Time API

Typedefs
typedef union RT_ComponentFactoryId	RT_ComponentFactoryId_T
	Abstract data-type to store the ID of a RT_ComponentFactory. Refer to RT_ComponentFactoryId_set_name to set a variable of this type.

Functions
RTI_BOOL	RT_Registry_register (RT_Registry_T *self, const char *name, struct RT_ComponentFactoryI *intf, struct RT_ComponentFactoryProperty *property, struct RT_ComponentFactoryListener *listener)
	<<cert>> Register a factory of RT components
RTI_BOOL	RT_Registry_unregister (RT_Registry_T *self, const char *name, struct RT_ComponentFactoryProperty **property, struct RT_ComponentFactoryListener **listener)
	<<cert>> Remove a component factory from the registry
RTI_BOOL	RT_ComponentFactoryId_set_name (RT_ComponentFactoryId_T *id, const char *const name)
	Set the component ID from a string name.

---

Detailed Description

The run-time module (RT) manages RTI Connext Micro modules. It provides a common interface to add, remove, and lookup components.

---

Typedef Documentation

typedef union RT_ComponentFactoryId RT_ComponentFactoryId_T

Abstract data-type to store the ID of a RT_ComponentFactory. Refer to RT_ComponentFactoryId_set_name to set a variable of this type.

---

Function Documentation

RTI_BOOL RT_Registry_register	(	RT_Registry_T *	self,
		const char *	name,
		struct RT_ComponentFactoryI *	intf,
		struct RT_ComponentFactoryProperty *	property,
		struct RT_ComponentFactoryListener *	listener
	)

<<cert>> Register a factory of RT components

In order to make a component available, it is necessary to register a factory for the components. The factory is responsible for creating and deleting components.

The name of the factory must be unique. Otherwise, if a factory already exists with the the same name, the registration will fail.

Parameters:

self	<<in>> Cannot be NULL.
name	<<in>> Name of the component factory
intf	<<in>> Pointer to the implementation of the factory interface
property	<<in>> Properties with which to create the factory
listener	<<in>> The listener to install with the factory

Returns:

RTI_TRUE on success, RTI_FALSE on failure

MT Safety:

This operation is not thread safe.

API Restriction:

This function must only be called after DDS_DomainParticipantFactory_get_instance.

See also:

RT_Registry_unregister

RTI_BOOL RT_Registry_unregister	(	RT_Registry_T *	self,
		const char *	name,
		struct RT_ComponentFactoryProperty **	property,
		struct RT_ComponentFactoryListener **	listener
	)

<<cert>> Remove a component factory from the registry

After a component factory is unregistered, it will no longer be possible to create or delete components with the factory.

Parameters:

self	<<in>> Cannot be NULL.
name	<<in>> Name of the component factory
property	<<in>> Properties with which the factory was created
listener	<<in>> The listener installed with the factory

Returns:

RTI_TRUE on success, RTI_FALSE on failure

MT Safety:

This operation is not thread safe.

See also:

RT_Registry_register

RTI_BOOL RT_ComponentFactoryId_set_name	(	RT_ComponentFactoryId_T *	id,
		const char *const	name
	)

Set the component ID from a string name.

Set the component ID from a string name. Cannot exceed 8 8-bit values, including the NUL string termination character.

Parameters:

id	<<inout>> The ID to set.
name	<<in>> The name to set.