RTI Cloud Discovery Service Version 7.3.0
|
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 Library 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_Service * | RTI_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 (void) |
DDS_Boolean | RTI_CDS_Service_is_started (struct RTI_CDS_Service *self) |
Query whether this RTI Cloud Discovery Service is currently started. More... | |
DDS_Boolean | RTI_CDS_Service_update_rtps_psk_secret_passphrase (struct RTI_CDS_Service *self, const char *rtps_psk_secret_passphrase) |
Sets the dds.sec.crypto.rtps_psk_secret_passphrase property for the RTI Cloud Discovery Service instance started with RTI_CDS_Service_start. More... | |
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:
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>/
An example is provided at https://github.com/rticommunity/rticonnextdds-examples/tree/release/7.3.0/examples/cloud_discovery_service/library_api.
Linux Systems | Windows Systems | |
---|---|---|
Link Libraries (Compile Time) | librticlouddiscoveryservice.so | rticlouddiscoveryservice.dll |
Shared Libraries (Run Time) | librtiroutingservice.so | rtiroutingservice.dll |
librtidlc.so | rtidlc.dll | |
librticonnextmsgc.so | rticonnextmsgc.dll | |
libnddsmetp.so | nddsmetp.dll | |
librtiapputilsc.so | rtiapputilsc.dll | |
librtixml2.so | rtixml2.dll | |
libnddsc.so | nddsc.dll | |
libnddscore.so | nddscore.dll | |
Static Libraries | librticlouddiscoveryservicez.a | rticlouddiscoveryservicez.lib |
librtiroutingservicez.a | rtiroutingservicez.lib | |
librtidlcz.a | rtidlcz.lib | |
librticonnextmsgcz.a | rticonnextmsgcz.lib | |
libnddsmetpz.a | nddsmetpz.lib | |
librtiapputilscz.a | rtiapputilscz.lib | |
librtixml2z.a | rtixml2z.lib | |
libnddscz.a | nddscz.lib | |
libnddscorez.a | nddscorez.lib | |
Headers | clouddiscoveryservice/clouddiscoveryservice_service.h |
NOTE: If you are using debug libraries, remember to add the 'd' suffix to the library name. For shared libraries on macOS systems, the library name is the same as that for Linux except the extension is '.dylib' instead of '.so'.
struct RTI_CDS_Service * RTI_CDS_Service_new | ( | const struct RTI_CDS_Property * | property | ) |
Create a new RTI Cloud Discovery Service instance.
e
property | The 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. |
void RTI_CDS_Service_delete | ( | struct RTI_CDS_Service * | self | ) |
Stop and delete an RTI Cloud Discovery Service instance.
e
self | An RTI_CDS_Service instance created with RTI_CDS_Service_new |
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.
self | An RTI_CDS_Service instance created with RTI_CDS_Service_new |
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.
self | An RTI_CDS_Service instance created with RTI_CDS_Service_new |
DDS_Boolean RTI_CDS_Service_finalize_globals | ( | void | ) |
e
[DEPRECATED]
Calling RTI_CDS_Service_finalize_globals() is no longer necessary and the function will be removed in future versions.
DDS_Boolean RTI_CDS_Service_is_started | ( | struct RTI_CDS_Service * | self | ) |
Query whether this RTI Cloud Discovery Service is currently started.
e
DDS_Boolean RTI_CDS_Service_update_rtps_psk_secret_passphrase | ( | struct RTI_CDS_Service * | self, |
const char * | rtps_psk_secret_passphrase | ||
) |
Sets the dds.sec.crypto.rtps_psk_secret_passphrase property for the RTI Cloud Discovery Service instance started with RTI_CDS_Service_start.
e
This operation performs an update; if there was no value for the dds.sec.crypto.rtps_psk_secret_passphrase in the XML configuration when RTI Cloud Discovery Service was started by calling RTI_CDS_Service_start, the operation would fail.
self | An RTI_CDS_Service instance started with RTI_CDS_Service_start |
rtps_psk_secret_passphrase | The new value for the dds.sec.crypto.rtps_psk_secret_passphrase property |