RTI Cloud Discovery Service Version 7.3.0
|
Configuration properties for a RTI Cloud Discovery Service object. More...
#include <ServiceProperty.hpp>
Inherits rti::core::NativeValueType< ServiceProperty >.
Public Member Functions | |
ServiceProperty () | |
Creates a property object with default settings. More... | |
std::string | cfg_file () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | cfg_file (const std::string &filename) |
Path to an RTI Cloud Discovery Service configuration file. More... | |
const std::vector< std::string > & | cfg_strings () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | cfg_strings (const std::vector< std::string > &the_cfg_strings) |
XML configuration represented as strings. More... | |
std::string | service_name () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | service_name (const std::string &name) |
The name of the RTI Cloud Discovery Service configuration to run. More... | |
std::string | application_name () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | application_name (const std::string &name) |
Assigns a name to the execution of the RTI Cloud Discovery Service. More... | |
bool | enforce_xsd_validation () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | enforce_xsd_validation (const bool enforce_xsd_validation) |
Controls whether the service applies XSD validation to the loaded configuration. More... | |
bool | skip_default_files () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | skip_default_files (const bool &skip) |
Set it to true to avoid loading the standard files usually loaded by RTI Cloud Discovery Service. More... | |
std::vector< TransportUnicastProperty > | transport_selection () |
Getter (see setter with the same name) More... | |
ServiceProperty & | transport_selection (const std::vector< TransportUnicastProperty > &transport_selection) |
Specifies the transport and receive ports used to receive and send discovery traffic. Specifically, a receive resource is uniquely specified by a transport class-receive port pair. Overrides XML configuration if specified. More... | |
DomainListProperty | domain_list () |
Getter (see setter with the same name) More... | |
ServiceProperty & | domain_list (const DomainListProperty &domain_list) |
Specifies the set of domain IDs the service will accept announcements from. More... | |
bool | enable_administration () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | enable_administration (const bool enable) |
Set this to true to enable remote administration or false to disable it. More... | |
int | administration_domain_id () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | administration_domain_id (const int 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 (const bool enable) |
Set this to true to enable monitoring or false to disable it. More... | |
int | monitoring_domain_id () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | monitoring_domain_id (const int domain_id) |
If ServiceProperty::enable_monitoring is true, this is the domain ID to use for publishing monitoring topics. More... | |
std::string | license_file_name () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | license_file_name (const std::string &file_name) |
Path to an RTI Cloud Discovery Service license file. More... | |
std::map< std::string, std::string > | user_environment () const |
Getter (see setter with the same name) More... | |
ServiceProperty & | user_environment (const std::map< std::string, std::string > &user_environment) |
Dictionary of user variables. More... | |
Configuration properties for a RTI Cloud Discovery Service object.
|
inline |
Creates a property object with default settings.
|
inline |
Getter (see setter with the same name)
Referenced by cfg_file().
|
inline |
Path to an RTI Cloud Discovery Service configuration file.
[default] Empty string.
References cfg_file().
|
inline |
Getter (see setter with the same name)
Referenced by cfg_strings().
|
inline |
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 ServiceProperty::cfg_file is empty.
The reason for using an array instead of one single string is to get around the limited size of literal strings. In general, if you create the XML string dynamically the vector needs only one element.
[default] Empty.
References cfg_strings().
|
inline |
Getter (see setter with the same name)
Referenced by service_name().
|
inline |
The name of the RTI Cloud Discovery Service configuration 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] 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 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 not set.
References application_name().
|
inline |
Getter (see setter with the same name)
References enforce_xsd_validation().
Referenced by enforce_xsd_validation().
|
inline |
Controls whether the service applies XSD validation to the loaded configuration.
[default] true
References enforce_xsd_validation().
|
inline |
Getter (see setter with the same name)
References skip_default_files().
Referenced by skip_default_files().
|
inline |
Set it to true to avoid loading the standard files usually loaded by RTI Cloud Discovery Service.
Only the configuration in ServiceProperty::cfg_file or ServiceProperty::cfg_strings will be loaded.
[default] false
References skip_default_files().
|
inline |
Getter (see setter with the same name)
References transport_selection().
Referenced by transport_selection().
|
inline |
Specifies the transport and receive ports used to receive and send discovery traffic. Specifically, a receive resource is uniquely specified by a transport class-receive port pair. Overrides XML configuration if specified.
[default] Unspecified. Use value from XML configuration.
References transport_selection().
|
inline |
|
inline |
Specifies the set of domain IDs the service will accept announcements from.
[default] Unspecified. Use value from XML configuration.
References domain_list().
|
inline |
Getter (see setter with the same name)
References enable_administration().
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)
Referenced by administration_domain_id().
|
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
References administration_domain_id().
|
inline |
Getter (see setter with the same name)
References enable_monitoring().
Referenced by enable_monitoring().
|
inline |
Set this to true to enable monitoring or false to disable it.
[default] false
References enable_monitoring().
|
inline |
Getter (see setter with the same name)
Referenced by monitoring_domain_id().
|
inline |
If ServiceProperty::enable_monitoring is true, this is the domain ID to use for publishing monitoring topics.
Takes precedence over the XML configuration. If ServiceProperty::enable_monitoring is false, this value is not used even if monitoring is enabled in the XML configuration.
[default] 0
References monitoring_domain_id().
|
inline |
Getter (see setter with the same name)
Referenced by license_file_name().
|
inline |
Path to an RTI Cloud Discovery Service license file.
If not empty, this file is checked for a valid license; otherwise, default location will be used. This parameter is only used if your installation requires a license file.
[default] empty string.
References license_file_name().
|
inline |
Getter (see setter with the same name)
References user_environment().
Referenced by user_environment().
|
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().