rti::cds::Service Class Reference

The RTI Cloud Discovery Service. More...

#include <Service.hpp>

Inherits dds::core::Reference< CloudDiscoveryServiceImpl >.

Public Member Functions
	Service (const ServiceProperty &property)
	Creates a RTI Cloud Discovery Service instance. More...
void	start ()
	Starts RTI Cloud Discovery Service. More...
void	stop ()
	Stops RTI Cloud Discovery Service. More...
bool	is_started ()
	Returns true if the RTI Cloud Discovery Service is started. More...
bool	update_rtps_psk_secret_passphrase (const std::string rtps_psk_secret_passphrase)
	Sets the dds.sec.crypto.rtps_psk_secret_passphrase property for the RTI Cloud Discovery Service instance that is started. More...

Static Public Member Functions
static void	finalize_globals ()

Detailed Description

The RTI Cloud Discovery Service.

Constructor & Destructor Documentation

Service()

rti::cds::Service::Service ( const ServiceProperty &  property )

inlineexplicit

Creates a RTI Cloud Discovery Service instance.

Parameters

property

<<in>> The property to configure RTI Cloud Discovery Service instance.

Member Function Documentation

start()

void rti::cds::Service::start ( )

inline

Starts RTI Cloud Discovery Service.

This is a non-blocking operation. RTI Cloud Discovery Service will create its own set of threads to perform its tasks.

stop()

void rti::cds::Service::stop ( )

inline

Stops RTI Cloud Discovery Service.

This operation will block until the instance is fully stopped.

is_started()

bool rti::cds::Service::is_started ( )

inline

Returns true if the RTI Cloud Discovery Service is started.

This operation is useful to inspect if the RTI Cloud Discovery Service instance is up and running.

update_rtps_psk_secret_passphrase()

bool rti::cds::Service::update_rtps_psk_secret_passphrase ( const std::string  rtps_psk_secret_passphrase )

inline

Sets the dds.sec.crypto.rtps_psk_secret_passphrase property for the RTI Cloud Discovery Service instance that is started.

This operation performs an update; if there was no value for the dds.sec.crypto.rtps_psk_secret_passphrase property in the XML configuration when RTI Cloud Discovery Service was started, the operation would fail.

Parameters

rtps_psk_secret_passphrase

The new value for the dds.sec.crypto.rtps_psk_secret_passphrase property

finalize_globals()

static void rti::cds::Service::finalize_globals ( )

inlinestatic

[DEPRECATED] Calling this function at the end of the application is no longer necessary. It will be removed in future versions.

References rti::cds::Logger::warn().