|
RTI Routing Service
Version 7.0.0
|
Configuration of RTI Routing Service. More...
Public Member Functions | |
| RoutingServiceProperty () | |
| Constructor. More... | |
Public Attributes | |
| String | cfgFile |
| Path to an RTI Routing Service configuration file. More... | |
| String [] | cfgStrings |
| XML configuration represented as strings. More... | |
| String | serviceName |
| The name of the Routing Service instance to run. More... | |
| String | applicationName |
| Assigns a name to the execution of the RTI Routing Service. More... | |
| boolean | enforceXsdValidation = true |
| Controls whether the service applies XSD validation to the loaded configuration. More... | |
| int | serviceVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS |
| The verbosity of the service. More... | |
| int | ddsVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS |
| The verbosity of the service. More... | |
| int | domainIdBase = 0 |
| Value that is added to the domain IDs of the domain routes in the XML configuration. More... | |
| String | pluginSearchPath |
| This path is used to look for plug-in libraries. More... | |
| boolean | dontStartService = false |
| Set this to true to if you do not want RTI Routing Service enabled when RoutingService.start is called. More... | |
| boolean | enableAdministration = false |
| Set this to true to enable remote administration or false to disable it. More... | |
| int | administrationDomainId = 0 |
| If enableAdministration is true, this is the domain ID to use for remote administration. More... | |
| boolean | enableMonitoring = false |
| Set it to true to enable remote monitoring or false to disable it. More... | |
| int | monitoringDomainId = 0 |
| If enableMonitoring is true, this is the domain ID to use for remote monitoring. More... | |
| boolean | skipDefaultFiles = false |
| Set it to true to avoid loading the standard files usually loaded by RTI Routing Service. More... | |
| boolean | identifyExecution = false |
| Set this to true to append the host name and process ID to the RTI Routing Service execution name. More... | |
| String | licenseFileName |
| Path to an RTI Routing Service license file. More... | |
| Properties | user_environment = new Properties() |
| 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.
Constructor.
| String cfgFile |
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.
| String [] cfgStrings |
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 cfgFile 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 Java. In general, if you create the XML string dynamically the array needs only one element:
[default] NULL.
| String serviceName |
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)
| String applicationName |
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".
| boolean enforceXsdValidation = true |
Controls whether the service applies XSD validation to the loaded configuration.
[default] true
| int serviceVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS |
The verbosity of the service.
Values:
[default] RoutingService.LOG_VERBOSITY_EXCEPTIONS
| int ddsVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS |
The verbosity of the service.
Values:
[default] RoutingService.LOG_VERBOSITY_EXCEPTIONS
| int domainIdBase = 0 |
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
| String pluginSearchPath |
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)
| boolean dontStartService = false |
Set this to true to if you do not want RTI Routing Service enabled when RoutingService.start is called.
RTI Routing Service can be enabled afterwards through remote administration.
[default] DDS_BOOLEAN_FALSE
| boolean enableAdministration = false |
Set this to true to enable remote administration or false to disable it.
[default] DDS_BOOLEAN_FALSE
| int administrationDomainId = 0 |
If enableAdministration is true, this is the domain ID to use for remote administration.
Takes precedence over the XML configuration. If enableAdministration is false, this value is not used even if remote administration is enabled in the XML configuration.
[default] 0
| boolean enableMonitoring = false |
Set it to true to enable remote monitoring or false to disable it.
[default] false
| int monitoringDomainId = 0 |
If enableMonitoring is true, this is the domain ID to use for remote monitoring.
Takes precedence over the XML configuration. If enableMonitoring is false, this value is not used, even if remote monitoring is enabled in the XML configuration.
[default] 0
| boolean skipDefaultFiles = false |
Set it to true to avoid loading the standard files usually loaded by RTI Routing Service.
Only the configuration in cfgFile or cfgStrings will be loaded.
[default] DDS_BOOLEAN_FALSE
| boolean identifyExecution = false |
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] false
| String licenseFileName |
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.
| Properties user_environment = new Properties() |
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