RTI Cloud Discovery Service  Version 6.1.1
RTI_CDS_Property Struct Reference

Configuration property for RTI Cloud Discovery Service. More...

Data Fields

char * cfg_file
 Path to an RTI Cloud Discovery Service configuration file. More...
 
const char ** cfg_strings
 XML configuration represented as strings. More...
 
unsigned int cfg_strings_count
 Size of the array cfg_strings. More...
 
char * service_name
 The name of the RTI Cloud Discovery Service instance to run. More...
 
char * application_name
 Assigns a name to the execution of the RTI Cloud Discovery Service. More...
 
DDS_Boolean enforce_xsd_validation
 Controls whether the service applies XSD validation to the loaded configuration. More...
 
DDS_Boolean skip_default_files
 Set it to true to avoid loading the standard files usually loaded by RTI Cloud Discovery Service. More...
 
int service_verbosity
 The verbosity of the service. More...
 
int dds_verbosity
 The verbosity of RTI Connext core libraries. More...
 
struct RTI_CDS_TransportSelectionProperty transport_selection
 Specifies the transport and receive ports used to receive and send discovery traffic. Specifically, a receive resource is uniquely identified by a transport class-receive port pair. Overrides XML configuration if specified. More...
 
struct RTI_CDS_DomainListProperty domain_list
 Specifies the set of domain IDs the service will accept announcements from. More...
 
DDS_Boolean enable_administration
 Set this to true to enable remote administration or false to disable it. More...
 
int administration_domain_id
 If enable_administration is true, this is the domain ID to use for remote administration. More...
 
DDS_Boolean enable_monitoring
 Set this to true to enable monitoring or false to disable it. More...
 
int monitoring_domain_id
 If enable_monitoring is true, this is the domain ID to use for publishing monitoring topics. More...
 
char * license_file_name
 Path to an RTI Cloud Discovery Service license file. More...
 
struct RTI_RoutingServiceProperties user_environment
 Dictionary of user variables. The dictionary provides a parallel way to expand XML configuration variables in the form , when they are not defined in the environment. More...
 

Detailed Description

Configuration property for RTI Cloud Discovery Service.

Field Documentation

◆ cfg_file

char* RTI_CDS_Property::cfg_file

Path to an RTI Cloud Discovery Service configuration file.

If not NULL, this file is loaded; otherwise, if cfg_strings is not NULL, that XML code is loaded

[default] NULL.

◆ cfg_strings

const char** RTI_CDS_Property::cfg_strings

XML configuration represented as strings.

An array of strings that altogether make up an XML document to configure RTI Cloud Discovery Service. This parameter is used only if cfg_file is NULL.

For example:

int MY_CLOUD_DISCOVERY_SERVICE_CFG_SIZE = 3;
const char * MY_CLOUD_DISCOVERY_SERVICE_CFG[MY_CLOUD_DISCOVERY_SERVICE_CFG_SIZE] =
{"<dds>
<cloud_discovery_service name=\"MyServiceName\">"
...
</cloud_discovery_service>
</dds>"};
property.cfg_strings = MY_CLOUD_DISCOVERY_SERVICE_CFG;
property.cfg_strings_count = MY_CLOUD_DISCOVERY_SERVICE_CFG_SIZE;

The reason for using an array instead of one single string is to get around the limited size of literal strings in C. In general, if you create the XML string dynamically using one single string in the array, setting cfg_strings_count to 1 is enough:

property.cfg_strings = malloc(sizeof(char *));
property.cfg_strings[0] = "<dds><cloud_discovery_service>...</dds>";
property.cfg_strings_count = 1;

If your target system doesn't support a file system, you can use XML strings to configure the service. To ease this process, a utility is shipped to generate a C string array from a text file. You can find this utility in [RTI Cloud Discovery Service installation directory]/resource/perl/cStringifyFile.pl

[default] NULL.

◆ cfg_strings_count

unsigned int RTI_CDS_Property::cfg_strings_count

Size of the array cfg_strings.

[default] 0.

◆ service_name

char* RTI_CDS_Property::service_name

The name of the RTI Cloud Discovery Service instance to run.

This is the name used to find the <cloud_discovery_service> XML tag in the configuration file; this is the default name that will be used to refer to this execution in remote administration and monitoring if application_name isn't specified.

[default] NULL (use built-in configuration)

◆ application_name

char* RTI_CDS_Property::application_name

Assigns a name to the execution of the RTI Cloud Discovery Service.

Remote commands and status information will refer to the RTI Cloud Discovery Service using this name.

[default] service_name if this value is NULL.

◆ enforce_xsd_validation

DDS_Boolean RTI_CDS_Property::enforce_xsd_validation

Controls whether the service applies XSD validation to the loaded configuration.

[default] DDS_BOOLEAN_TRUE

◆ skip_default_files

DDS_Boolean RTI_CDS_Property::skip_default_files

Set it to true to avoid loading the standard files usually loaded by RTI Cloud Discovery Service.

Only the configuration in cfg_file or cfg_strings will be loaded.

[default] DDS_BOOLEAN_FALSE

◆ service_verbosity

int RTI_CDS_Property::service_verbosity

◆ dds_verbosity

int RTI_CDS_Property::dds_verbosity

◆ transport_selection

struct RTI_CDS_TransportSelectionProperty RTI_CDS_Property::transport_selection

Specifies the transport and receive ports used to receive and send discovery traffic. Specifically, a receive resource is uniquely identified by a transport class-receive port pair. Overrides XML configuration if specified.

◆ domain_list

struct RTI_CDS_DomainListProperty RTI_CDS_Property::domain_list

Specifies the set of domain IDs the service will accept announcements from.

[default] Unspecified. Use value from XML configuration.

◆ enable_administration

DDS_Boolean RTI_CDS_Property::enable_administration

Set this to true to enable remote administration or false to disable it.

[default] DDS_BOOLEAN_FALSE

◆ administration_domain_id

int RTI_CDS_Property::administration_domain_id

If enable_administration is true, this is the domain ID to use for remote administration.

Takes precedence over the XML configuration. If enable_administration is false, this value is not used even if remote administration is enabled in the XML configuration.

[default] 0

◆ enable_monitoring

DDS_Boolean RTI_CDS_Property::enable_monitoring

Set this to true to enable monitoring or false to disable it.

[default] DDS_BOOLEAN_FALSE

◆ monitoring_domain_id

int RTI_CDS_Property::monitoring_domain_id

If enable_monitoring is true, this is the domain ID to use for publishing monitoring topics.

Takes precedence over the XML configuration. If enable_monitoring is false, this value is not used even if monitoring is enabled in the XML configuration.

[default] 0

◆ license_file_name

char* RTI_CDS_Property::license_file_name

Path to an RTI Cloud Discovery Service license file.

If not NULL, this file is checked for a valid license; otherwise, default location will be used. This parameter is not used in unlicensed versions.

[default] NULL.

◆ user_environment

struct RTI_RoutingServiceProperties RTI_CDS_Property::user_environment

Dictionary of user variables. The dictionary provides a parallel way to expand XML configuration variables in the form , when they are not defined in the environment.

[default] empty