RTI Connext DDS Micro C API  Version 4.0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
RT Run-Time API

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)
 Assign a name to a RT_ComponentFactoryId_T variable.

Detailed Description

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


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
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
See also:
RT_Registry_register
RTI_BOOL RT_ComponentFactoryId_set_name ( RT_ComponentFactoryId_T *  id,
const char *const  name 
)

Assign a name to a RT_ComponentFactoryId_T variable.

Use this function to assign a name to a RT_ComponentFactoryId_T variable, such as the name of the discovery plugin to use.

Parameters:
id<<in>> Id to initialize
name<<in>> Name to initialize with
Returns:
RTI_TRUE on success, RTI_FALSE on failure

RTI Connext DDS Micro C API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc