|
RTI Routing Service Version 7.1.0
|
Configuration of RTI Routing Service. More...
Data Fields | |
| char * | cfg_file |
| Path to an RTI Routing Service configuration file. More... | |
| const char ** | cfg_strings |
| XML configuration represented as strings. More... | |
| int | cfg_strings_count |
| Size of the array cfg_strings. More... | |
| char * | service_name |
| The name of the Routing Service instance to run. More... | |
| char * | application_name |
| Assigns a name to the execution of the RTI Routing Service. More... | |
| DDS_Boolean | enforce_xsd_validation |
| Controls whether the service applies XSD validation to the loaded configuration. More... | |
| int | service_verbosity |
| The verbosity of the service. More... | |
| int | dds_verbosity |
| The verbosity of RTI Connext core libraries. More... | |
| int | domain_id_base |
| Value that is added to the domain IDs of the domain routes in the XML configuration. More... | |
| char * | plugin_search_path |
| This path is used to look for plug-in libraries. More... | |
| DDS_Boolean | dont_start_service |
| Set this to true to if you do not want RTI Routing Service enabled when RTI_RoutingService_start is called. 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 it to true to enable remote monitoring or false to disable it. More... | |
| int | monitoring_domain_id |
| If enable_monitoring is true, this is the domain ID to use for remote monitoring. More... | |
| DDS_Boolean | skip_default_files |
| Set it to true to avoid loading the standard files usually loaded by RTI Routing Service. More... | |
| DDS_Boolean | identify_execution |
| Set this to true to append the host name and process ID to the RTI Routing Service execution name. More... | |
| struct RTI_RoutingServiceTransportConfig | registered_transports [8] |
| Transports to be loaded by RTI Connext. More... | |
| int | registered_transports_count |
| Number of transports configured in registered_transports. More... | |
| char * | license_file_name |
| Path to an RTI Routing 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... | |
Configuration of RTI Routing Service.
This structure must be initialized with RTI_RoutingServiceProperty_INITIALIZER.
| char* RTI_RoutingServiceProperty::cfg_file |
Path to an RTI Routing Service configuration file.
If not NULL, this file is loaded; otherwise, if cfg_strings is not NULL, that XML code is loaded.
[default] NULL.
| const char** RTI_RoutingServiceProperty::cfg_strings |
XML configuration represented as strings.
An array of strings that altogether make up an XML document to configure RTI Routing Service. This parameter is used only if cfg_file is NULL.
For example:
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:
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 Routing Service installation directory]/resource/perl/cStringifyFile.pl
[default] NULL.
| int RTI_RoutingServiceProperty::cfg_strings_count |
Size of the array cfg_strings.
[default] 0.
| char* RTI_RoutingServiceProperty::service_name |
The name of the Routing Service instance to run.
This is the name used to find the <routing_service> XML tag in the configuration file; the name that will be used to refer to this execution in remote administration and monitoring.
[default] NULL (use RTI_RoutingService)
| char* RTI_RoutingServiceProperty::application_name |
Assigns a name to the execution of the RTI Routing Service.
Remote commands and status information will refer to the routing service using this name. In addition, the name of DomainParticipants created by RTI Routing Service will be based on this name.
[default] service_name if this value is different than NULL. Otherwise, "RTI_Routing_Service".
| DDS_Boolean RTI_RoutingServiceProperty::enforce_xsd_validation |
Controls whether the service applies XSD validation to the loaded configuration.
[default] DDS_BOOLEAN_TRUE
| int RTI_RoutingServiceProperty::service_verbosity |
The verbosity of the service.
Values:
[default] RTI_ROUTING_SERVICE_LOG_VERBOSITY_EXCEPTIONS
| int RTI_RoutingServiceProperty::dds_verbosity |
The verbosity of RTI Connext core libraries.
Values:
[default] RTI_ROUTING_SERVICE_LOG_VERBOSITY_EXCEPTIONS
| int RTI_RoutingServiceProperty::domain_id_base |
Value that is added to the domain IDs of the domain routes in the XML configuration.
By using this, an XML file can use relative domain IDs.
[default] 0
| char* RTI_RoutingServiceProperty::plugin_search_path |
This path is used to look for plug-in libraries.
If the plug-in class libraries specified in the XML file don't contain a full path, RTI Routing Service looks for them in this directory. If not present, it will rely on the system library path.
[default] NULL (current directory)
| DDS_Boolean RTI_RoutingServiceProperty::dont_start_service |
Set this to true to if you do not want RTI Routing Service enabled when RTI_RoutingService_start is called.
RTI Routing Service can be enabled afterwards through remote administration.
[default] DDS_BOOLEAN_FALSE
| DDS_Boolean RTI_RoutingServiceProperty::enable_administration |
Set this to true to enable remote administration or false to disable it.
[default] DDS_BOOLEAN_FALSE
| int RTI_RoutingServiceProperty::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
| DDS_Boolean RTI_RoutingServiceProperty::enable_monitoring |
Set it to true to enable remote monitoring or false to disable it.
[default] DDS_BOOLEAN_FALSE
| int RTI_RoutingServiceProperty::monitoring_domain_id |
If enable_monitoring is true, this is the domain ID to use for remote monitoring.
Takes precedence over the XML configuration. If enable_monitoring is false, this value is not used, even if remote monitoring is enabled in the XML configuration.
[default] 0
| DDS_Boolean RTI_RoutingServiceProperty::skip_default_files |
Set it to true to avoid loading the standard files usually loaded by RTI Routing Service.
Only the configuration in cfg_file or cfg_strings will be loaded.
[default] DDS_BOOLEAN_FALSE
| DDS_Boolean RTI_RoutingServiceProperty::identify_execution |
Set this to true to append the host name and process ID to the RTI Routing Service execution name.
Used to get unique names for remote administration and monitoring.
[default] DDS_BOOLEAN_FALSE
| struct RTI_RoutingServiceTransportConfig RTI_RoutingServiceProperty::registered_transports[8] |
Transports to be loaded by RTI Connext.
| int RTI_RoutingServiceProperty::registered_transports_count |
Number of transports configured in registered_transports.
[default] 0
| char* RTI_RoutingServiceProperty::license_file_name |
Path to an RTI Routing 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.
| struct RTI_RoutingServiceProperties RTI_RoutingServiceProperty::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