Configuration properties for a RTI Cloud Discovery Service object. More...

#include <ServiceProperty.hpp>

Inherits 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 &filename)
	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. The dictionary provides a parallel way to expand XML configuration variables in the form , when they are not defined in the environment. More...

Detailed Description

Configuration properties for a RTI Cloud Discovery Service object.

Constructor & Destructor Documentation

◆ ServiceProperty()

rti::cds::ServiceProperty::ServiceProperty ( )

inline

Creates a property object with default settings.

Member Function Documentation

◆ cfg_file() [1/2]

std::string rti::cds::ServiceProperty::cfg_file ( ) const

inline

Getter (see setter with the same name)

◆ cfg_file() [2/2]

ServiceProperty& rti::cds::ServiceProperty::cfg_file ( const std::string & filename )

inline

Path to an RTI Cloud Discovery Service configuration file.

[default] Empty string.

◆ cfg_strings() [1/2]

const std::vector<std::string>& rti::cds::ServiceProperty::cfg_strings ( ) const

inline

Getter (see setter with the same name)

◆ cfg_strings() [2/2]

ServiceProperty& rti::cds::ServiceProperty::cfg_strings ( const std::vector< std::string > & the_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.

◆ service_name() [1/2]

std::string rti::cds::ServiceProperty::service_name ( ) const

inline

Getter (see setter with the same name)

◆ service_name() [2/2]

ServiceProperty& rti::cds::ServiceProperty::service_name ( const std::string & 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.

◆ application_name() [1/2]

std::string rti::cds::ServiceProperty::application_name ( ) const

inline

Getter (see setter with the same name)

◆ application_name() [2/2]

ServiceProperty& rti::cds::ServiceProperty::application_name ( const std::string & 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.

◆ enforce_xsd_validation() [1/2]

bool rti::cds::ServiceProperty::enforce_xsd_validation ( ) const

inline

Getter (see setter with the same name)

Referenced by enforce_xsd_validation().

◆ enforce_xsd_validation() [2/2]

ServiceProperty& rti::cds::ServiceProperty::enforce_xsd_validation ( const bool enforce_xsd_validation )

inline

Controls whether the service applies XSD validation to the loaded configuration.

[default] true

References enforce_xsd_validation().

◆ skip_default_files() [1/2]

bool rti::cds::ServiceProperty::skip_default_files ( ) const

inline

Getter (see setter with the same name)

Referenced by skip_default_files().

◆ skip_default_files() [2/2]

ServiceProperty& rti::cds::ServiceProperty::skip_default_files ( const bool & skip )

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().

◆ transport_selection() [1/2]

std::vector<TransportUnicastProperty> rti::cds::ServiceProperty::transport_selection ( )

inline

Getter (see setter with the same name)

◆ transport_selection() [2/2]

ServiceProperty& rti::cds::ServiceProperty::transport_selection ( const std::vector< TransportUnicastProperty > & 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.

◆ domain_list() [1/2]

DomainListProperty rti::cds::ServiceProperty::domain_list ( )

inline

Getter (see setter with the same name)

◆ domain_list() [2/2]

ServiceProperty& rti::cds::ServiceProperty::domain_list ( const DomainListProperty & domain_list )

inline

Specifies the set of domain IDs the service will accept announcements from.

[default] Unspecified. Use value from XML configuration.

◆ enable_administration() [1/2]

bool rti::cds::ServiceProperty::enable_administration ( ) const

inline

Getter (see setter with the same name)

Referenced by enable_administration().

◆ enable_administration() [2/2]

ServiceProperty& rti::cds::ServiceProperty::enable_administration ( const bool enable )

inline

Set this to true to enable remote administration or false to disable it.

[default] false

References enable_administration().

◆ administration_domain_id() [1/2]

int rti::cds::ServiceProperty::administration_domain_id ( ) const

inline

Getter (see setter with the same name)

Referenced by administration_domain_id().

◆ administration_domain_id() [2/2]

ServiceProperty& rti::cds::ServiceProperty::administration_domain_id ( const int 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().

◆ enable_monitoring() [1/2]

bool rti::cds::ServiceProperty::enable_monitoring ( ) const

inline

Getter (see setter with the same name)

Referenced by enable_monitoring().

◆ enable_monitoring() [2/2]

ServiceProperty& rti::cds::ServiceProperty::enable_monitoring ( const bool enable )

inline

Set this to true to enable monitoring or false to disable it.

[default] false

References enable_monitoring().

◆ monitoring_domain_id() [1/2]

int rti::cds::ServiceProperty::monitoring_domain_id ( ) const

inline

Getter (see setter with the same name)

Referenced by monitoring_domain_id().

◆ monitoring_domain_id() [2/2]

ServiceProperty& rti::cds::ServiceProperty::monitoring_domain_id ( const int 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().

◆ license_file_name() [1/2]

std::string rti::cds::ServiceProperty::license_file_name ( ) const

inline

Getter (see setter with the same name)

◆ license_file_name() [2/2]

ServiceProperty& rti::cds::ServiceProperty::license_file_name ( const std::string & filename )

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 not used in unlicensed versions.

[default] empty string.

◆ user_environment() [1/2]

std::map<std::string, std::string> rti::cds::ServiceProperty::user_environment ( ) const

inline

Getter (see setter with the same name)

◆ user_environment() [2/2]

ServiceProperty& rti::cds::ServiceProperty::user_environment ( const std::map< std::string, std::string > & 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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ServiceProperty()

Member Function Documentation

◆ cfg_file() [1/2]

◆ cfg_file() [2/2]

◆ cfg_strings() [1/2]

◆ cfg_strings() [2/2]

◆ service_name() [1/2]

◆ service_name() [2/2]

◆ application_name() [1/2]

◆ application_name() [2/2]

◆ enforce_xsd_validation() [1/2]

◆ enforce_xsd_validation() [2/2]

◆ skip_default_files() [1/2]

◆ skip_default_files() [2/2]

◆ transport_selection() [1/2]

◆ transport_selection() [2/2]

◆ domain_list() [1/2]

◆ domain_list() [2/2]

◆ enable_administration() [1/2]

◆ enable_administration() [2/2]

◆ administration_domain_id() [1/2]

◆ administration_domain_id() [2/2]

◆ enable_monitoring() [1/2]

◆ enable_monitoring() [2/2]

◆ monitoring_domain_id() [1/2]

◆ monitoring_domain_id() [2/2]

◆ license_file_name() [1/2]

◆ license_file_name() [2/2]

◆ user_environment() [1/2]

◆ user_environment() [2/2]