RTI Recording Service Version 7.3.0
|
Configuration for a RTI Recording Service object. More...
#include <ServiceProperty.hpp>
Public Member Functions | |
ServiceProperty () | |
Creates a property object with default settings. More... | |
const std::string & | cfg_file () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | cfg_file (const std::string &cfg_file) |
Path to an RTI Recording Service configuration file. More... | |
const std::string & | service_name () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | service_name (const std::string &service_name) |
The name of the RTI Recording Service configuration to run. More... | |
const std::string & | application_name () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | application_name (const std::string &application_name) |
Assigns a name to the execution of the RTI Recording Service. More... | |
int32_t | domain_id_base () const |
Getter (see setter with the same name) More... | |
bool | enforce_xsd_validation () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | enforce_xsd_validation (bool enforce) |
Controls whether the service applies XSD validation to the loaded configuration. More... | |
ServiceProperty & | domain_id_base (int32_t domain_id) |
Value that is added to the domain IDs of the domain routes in the XML configuration. More... | |
bool | enable_administration () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | enable_administration (bool enable_administration) |
Set this to true to enable remote administration or false to disable it. More... | |
int32_t | administration_domain_id () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | administration_domain_id (int32_t domain_id) |
If ServiceProperty::enable_administration is true, this is the domain ID to use for remote administration. More... | |
bool | enable_monitoring () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | enable_monitoring (bool enable_monitoring) |
Set it to true to enable remote monitoring or false to disable it. More... | |
int32_t | monitoring_domain_id () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | monitoring_domain_id (int32_t domain_id) |
If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring. More... | |
const ApplicationRoleKind & | application_role () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | application_role (ApplicationRoleKind application_role) |
Selects the operation mode of the service. More... | |
bool | ignore_default_files () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | ignore_default_files (bool ignore) |
Set it to true to avoid loading the standard files usually loaded by RTI Recording Service. More... | |
const std::string & | license_file () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | license_file (const std::string &license_file) |
Path to an RTI Connext license file. This parameter is only used if your installation requires a license file. More... | |
bool | debug_mode () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | debug_mode (bool debug_mode) |
Set this to true to enable debug mode or false to disable it. More... | |
bool | reverse_mode () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | reverse_mode (bool reverse_mode) |
Set this to true to enable reverse mode or false to disable it. More... | |
const PropertySet & | user_environment () const |
Getter (see setter with the same name) More... | |
PropertySet & | user_environment () |
Non-const getter for modification that can be used to add elements individually. (see setter with the same name) More... | |
ServiceProperty & | user_environment (const PropertySet &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 for a RTI Recording Service object.
|
inline |
Creates a property object with default settings.
|
inline |
Getter (see setter with the same name)
Referenced by cfg_file().
|
inline |
|
inline |
Getter (see setter with the same name)
Referenced by service_name().
|
inline |
The name of the RTI Recording Service configuration to run.
This is the name used to find the service XML tag in the configuration file; the name that will be used to refer to this execution in remote administration and monitoring.
[default] empty string.
References service_name().
|
inline |
Getter (see setter with the same name)
Referenced by application_name().
|
inline |
Assigns a name to the execution of the RTI Recording Service.
Remote commands and status information will refer to the service using this name.
In addition, the name of DomainParticipants created by RTI Recording Service will be based on this name.
[default] empty string. If no application name is specified, RTI Recording Service will use ServiceProperty::service_name.
References application_name().
|
inline |
Getter (see setter with the same name)
|
inline |
Getter (see setter with the same name)
|
inline |
Controls whether the service applies XSD validation to the loaded configuration.
[default] true
|
inline |
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
|
inline |
Getter (see setter with the same name)
Referenced by enable_administration().
|
inline |
Set this to true to enable remote administration or false to disable it.
[default] false
References enable_administration().
|
inline |
Getter (see setter with the same name)
|
inline |
If ServiceProperty::enable_administration is true, this is the domain ID to use for remote administration.
Takes precedence over the XML configuration. If ServiceProperty::enable_administration is false, this value is not used even if remote administration is enabled in the XML configuration.
[default] 0
|
inline |
Getter (see setter with the same name)
Referenced by enable_monitoring().
|
inline |
Set it to true to enable remote monitoring or false to disable it.
[default] false
References enable_monitoring().
|
inline |
Getter (see setter with the same name)
|
inline |
If ServiceProperty::enable_monitoring is true, this is the domain ID to use for remote monitoring.
Takes precedence over the XML configuration. If ServiceProperty::enable_monitoring is false, this value is not used, even if remote monitoring is enabled in the XML configuration.
[default] 0
|
inline |
Getter (see setter with the same name)
Referenced by application_role().
|
inline |
Selects the operation mode of the service.
References application_role().
|
inline |
Getter (see setter with the same name)
|
inline |
Set it to true to avoid loading the standard files usually loaded by RTI Recording Service.
Only the configuration in ServiceProperty::cfg_file or ServiceProperty::cfg_strings will be loaded.
[default] false
|
inline |
Getter (see setter with the same name)
Referenced by license_file().
|
inline |
Path to an RTI Connext license file. This parameter is only used if your installation requires a license file.
[default] empty string.
References license_file().
|
inline |
Getter (see setter with the same name)
Referenced by debug_mode().
|
inline |
Set this to true to enable debug mode or false to disable it.
[default] false
References debug_mode().
|
inline |
Getter (see setter with the same name)
Referenced by reverse_mode().
|
inline |
Set this to true to enable reverse mode or false to disable it.
[default] false
References reverse_mode().
|
inline |
Getter (see setter with the same name)
Referenced by user_environment().
|
inline |
Non-const getter for modification that can be used to add elements individually. (see setter with the same name)
|
inline |
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
References user_environment().