RTI Routing Service  Version 5.3.1
 All Classes Files Functions Variables Groups
RoutingServiceProperty Class Reference

Configuration of RTI Routing Service. More...

Public Member Functions

 RoutingServiceProperty ()
 Constructor.
 

Public Attributes

String cfgFile
 Path to an RTI Routing Service configuration file.
 
String[] cfgStrings
 XML configuration represented as strings.
 
String serviceName
 The name of the Routing Service instance to run.
 
String applicationName
 Assigns a name to the execution of the RTI Routing Service.
 
int serviceVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS
 The verbosity of the service.
 
int ddsVerbosity = RoutingService.LOG_VERBOSITY_EXCEPTIONS
 The verbosity of the service.
 
int domainIdBase = 0
 Value that is added to the domain IDs of the domain routes in the XML configuration.
 
String transformationSearchPath
 This path is used to look for transformation libraries.
 
boolean dontStartService = false
 Set this to true to if you do not want RTI Routing Service enabled when RoutingService.start is called.
 
boolean enableAdministration = false
 Set this to true to enable remote administration or false to disable it.
 
int administrationDomainId = 0
 If enableAdministration is true, this is the domain ID to use for remote administration.
 
boolean enableMonitoring = false
 Set it to true to enable remote monitoring or false to disable it.
 
int monitoringDomainId = 0
 If enableMonitoring is true, this is the domain ID to use for remote monitoring.
 
boolean skipDefaultFiles = false
 Set it to true to avoid loading the standard files usually loaded by RTI Routing Service.
 
boolean identifyExecution = false
 Set this to true to append the host name and process ID to the RTI Routing Service execution name.
 
boolean use42eAlignment = false
 Set this to true to make RTI Routing Service compatible with RTI Data Distribution 4.2e.
 
String licenseFileName
 Path to an RTI Routing Service license file.
 

Detailed Description

Configuration of RTI Routing Service.

Constructor & Destructor Documentation

Constructor.

Member Data Documentation

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:

property.cfg_strings = new String[3];
property.cfg_strings[0] = "<dds><routing_service>";
property.cfg_strings[1] = "<domain_route><participant_1><domai";
property.cfg_strings[2] = "n_id>0...</dds>";

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:

property.cfg_strings = new String[1];
// fill in property.cfg_strings[0]

[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".

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 transformationSearchPath

This path is used to look for transformation libraries.

If the transformation class libraries specified in the XML file don't contain a full path, RTI Routing Service looks for them in this directory if not NULL.

[default] NULL

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

boolean use42eAlignment = false

Set this to true to make RTI Routing Service compatible with RTI Data Distribution 4.2e.

[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.


RTI Routing Service Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc