RTI Cloud Discovery Service  Version 6.1.1
Service API

RTI Cloud Discovery Service can be deployed as a C library linked into your application on select architectures. More...

Modules

 Service Property
 Service Property for RTI Cloud Discovery Service. Use this in conjunction with Service API, to configure RTI Cloud Discovery Service in your code.
 

Data Structures

struct  RTI_CDS_Service
 RTI Cloud Discovery Service. More...
 

Functions

struct RTI_CDS_ServiceRTI_CDS_Service_new (const struct RTI_CDS_Property *property)
 Create a new RTI Cloud Discovery Service instance. More...
 
void RTI_CDS_Service_delete (struct RTI_CDS_Service *self)
 Stop and delete an RTI Cloud Discovery Service instance. More...
 
DDS_Boolean RTI_CDS_Service_start (struct RTI_CDS_Service *self)
 Start RTI Cloud Discovery Service. More...
 
DDS_Boolean RTI_CDS_Service_stop (struct RTI_CDS_Service *self)
 Stop RTI Cloud Discovery Service. More...
 
DDS_Boolean RTI_CDS_Service_finalize_globals ()
 Finalize global resources that RTI Cloud Discovery Service requires to operate. More...
 
DDS_Boolean RTI_CDS_Service_is_started (struct RTI_CDS_Service *self)
 Query whether this RTI Cloud Discovery Service is currently started. More...
 

Detailed Description

RTI Cloud Discovery Service can be deployed as a C library linked into your application on select architectures.

This API allows you to create, configure and start RTI Cloud Discovery Service instances from your application.

The following code shows the typical use of the API:

struct RTI_CDS_Property property = RTI_CDS_Property_INITIALIZER;
struct RTI_CDS_Service *service = NULL;
property.cfg_file = "my_cloud_discovery_service_cfg.xml";
property.service_name = "my_cloud_discovery_service";
...
service = RTI_CDS_Service_new(&property);
if (service == NULL) {
printf("Error ...");
return -1;
}
if (!RTI_CDS_Service_start(service)) {
printf("Error ...");
return -1;
}
while (keep_running) {
sleep();
...
}
return 0;

Instead of a file, you can use XML strings to configure RTI Cloud Discovery Service. See Service Property for more information.

To build your application you need to link with the RTI Cloud Discovery Service library in <RTI Connext home>/bin/<architecture>/

Development Requirements

Linux/macOS Systems Windows Systems
Shared Librarieslibrticlouddiscoveryservice.so rticlouddiscoveryservice.dll
^ librtiroutingservice.so rtiroutingservice.dll
^ librtirsinfrastructure.so rtirsinfrastructure.dll
^ librtidlc.so rtidlc.dll
^ libnddsmetp.so nddsmetp.dll
^ libnddsc.so nddsc.dll
^ librtixml2.so rtixml2.dll
^ libnddscore.so nddscore.dll
Headers clouddiscoveryservice/clouddiscoveryservice_service.h

Function Documentation

◆ RTI_CDS_Service_new()

struct RTI_CDS_Service* RTI_CDS_Service_new ( const struct RTI_CDS_Property property)

Create a new RTI Cloud Discovery Service instance.

e

Parameters
propertyThe properties to configure RTI Cloud Discovery Service. This parameter is copied internally, so the user is responsible for releasing any memory allocated inside this structure.

◆ RTI_CDS_Service_delete()

void RTI_CDS_Service_delete ( struct RTI_CDS_Service self)

Stop and delete an RTI Cloud Discovery Service instance.

e

See also
RTI_CDS_Service_stop
Parameters
selfAn RTI_CDS_Service instance created with RTI_CDS_Service_new

◆ RTI_CDS_Service_start()

DDS_Boolean RTI_CDS_Service_start ( struct RTI_CDS_Service self)

Start RTI Cloud Discovery Service.

e

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

Parameters
selfAn RTI_CDS_Service instance created with RTI_CDS_Service_new
Returns
True on success; False otherwise

◆ RTI_CDS_Service_stop()

DDS_Boolean RTI_CDS_Service_stop ( struct RTI_CDS_Service self)

Stop RTI Cloud Discovery Service.

e

This function won't return the execution control until the instance is fully stopped.

Parameters
selfAn RTI_CDS_Service instance created with RTI_CDS_Service_new
Returns
True on success; False otherwise

◆ RTI_CDS_Service_finalize_globals()

DDS_Boolean RTI_CDS_Service_finalize_globals ( )

Finalize global resources that RTI Cloud Discovery Service requires to operate.

e

This operation releases resources specific to RTI Cloud Discovery Service only. RTI Connext DDS global state shall be released separately through the DomainParticipantFactory's finalize_instance().

This operation should be called by your application only upon exit, after all service instances have been deleted. Calling it at a different time may cause the application to crash.

MT Safety:
Unsafe. Applications are not allowed to call this operation concurrently.
Returns
True on success; False otherwise.

◆ RTI_CDS_Service_is_started()

DDS_Boolean RTI_CDS_Service_is_started ( struct RTI_CDS_Service self)

Query whether this RTI Cloud Discovery Service is currently started.

e