Configuring QoS Profiles with XML

APIs related to XML QoS Profiles. More...

Classes
class	dds::core::QosProvider
	<<reference-type>> The QosProvider class provides a way for a user to control and access the XML QoS profiles that are loaded by RTI Connext More...
class	rti::core::QosProviderParams
	<<extension>> <<value-type>> Configure options that control the way that XML documents containing QoS profiles are loaded by a dds::core::QosProvider. More...

Detailed Description

APIs related to XML QoS Profiles.

Loading QoS Profiles from XML Resources

A 'QoS profile' is a group of QoS settings, specified in XML format. By using QoS profiles, you can change QoS settings without recompiling the application.

The Qos profiles are loaded the first time any of the following operations are called:

• Whenever a dds::domain::DomainParticipant is created
• dds::core::QosProvider::participant_qos(const std::string& id)
• dds::domain::DomainParticipant::default_participant_qos()
• dds::core::QosProvider::default_library(const std::string& library_name)
• dds::core::QosProvider::default_profile(const std::string& profile_name)
• dds::core::QosProvider::participant_qos(const std::string& id)
• dds::core::QosProvider::topic_qos(const std::string& id)
• dds::core::QosProvider::topic_qos_w_topic_name(const std::string& topic_name) const
• dds::core::QosProvider::topic_qos_w_topic_name(const std::string& id, const std::string& topic_name) const
• dds::core::QosProvider::publisher_qos(const std::string& id)
• dds::core::QosProvider::subscriber_qos(const std::string& id)
• dds::core::QosProvider::datawriter_qos(const std::string& id)
• dds::core::QosProvider::datawriter_qos_w_topic_name(const std::string& topic_name) const
• dds::core::QosProvider::datawriter_qos_w_topic_name(const std::string& id, const std::string& topic_name) const
• dds::core::QosProvider::datareader_qos(const std::string& id)
• dds::core::QosProvider::datareader_qos_w_topic_name(const std::string& topic_name) const
• dds::core::QosProvider::topic_qos_w_topic_name(const std::string& id, const std::string& topic_name) const
• dds::core::QosProvider::qos_profile_libraries()
• dds::core::QosProvider::qos_profiles()
• dds::core::QosProvider::load_profiles()

The QoS profiles are reloaded replacing previously loaded profiles when the following operations are called:

• dds::domain::DomainParticipant::participant_factory_qos(const dds::domain::qos::DomainParticipantFactoryQos& qos)
• dds::core::QosProvider::reload_profiles()

The dds::core::QosProvider::unload_profiles() operation will free the resources associated with the XML QoS profiles.

There are five ways to configure the XML resources (listed by load order):

• The file NDDS_QOS_PROFILES.xml in $NDDSHOME/resource/xml is loaded if it exists and rti::core::QosProviderParams::ignore_resource_profile in rti::core::QosProviderParams is set to false (first to be loaded). An example file, NDDS_QOS_PROFILES.example.xml, is available for reference.

• The URL groups separated by semicolons referenced by the enviroment variable NDDS_QOS_PROFILES are loaded if they exist and rti::core::QosProviderParams::ignore_environment_profile in rti::core::QosProviderParams is set to false.

• The file USER_QOS_PROFILES.xml in the working directory will be loaded if it exists and rti::core::QosProviderParams::ignore_user_profile in rti::core::QosProviderParams is set to false.

• The URL groups referenced by rti::core::QosProviderParams::url_profile in rti::core::QosProviderParams will be loaded if specified.

• The sequence of XML strings referenced by rti::core::QosProviderParams::string_profile will be loaded if specified (last to be loaded).

The above methods can be combined together.

URL

The location of the XML resources (only files and strings are supported) is specified using a URL (Uniform Resource Locator) format. For example:

File Specification: file:///usr/local/default_dds.xml

String Specification: str://"<dds><qos_library> . . . lt;/qos_library>&lt/dds>"

If the URL schema name is omitted, RTI Connext will assume a file name. For example:

File Specification: /usr/local/default_dds.xml

URL groups

To provide redundancy and fault tolerance, you can specify multiple locations for a single XML document via URL groups. The syntax of a URL group is as follows:

[URL1 | URL2 | URL2 | . . .| URLn]

For example:

[file:///usr/local/default_dds.xml | file:///usr/local/alternative_default_dds.xml]

Only one of the elements in the group will be loaded by RTI Connext, starting from the left.

Brackets are not required for groups with a single URL.

NDDS_QOS_PROFILES environment variable

The environment variable NDDS_QOS_PROFILES contains a list of URL groups separated by ';'

The URL groups referenced by the environment variable are loaded if they exist and rti::core::QosProviderParams::ignore_environment_profile is set to false

Built-In QoS Profiles

There are also a number of built-in QoS profiles that can be used without having to load any configurations from outside XML resources. For more information on these built-in profiles see Built-in Qos Profiles.

For more information on XML Configuration, refer to the User's Manual.