QosProvider

group qos_provider

The Qos Provider API.

Enums

enum dds_qos_kind

All kind of entities for which qos can be stored in Profile.

Values:

enumerator DDS_PARTICIPANT_QOS
enumerator DDS_PUBLISHER_QOS
enumerator DDS_SUBSCRIBER_QOS
enumerator DDS_TOPIC_QOS
enumerator DDS_READER_QOS
enumerator DDS_WRITER_QOS

Functions

dds_return_t dds_create_qos_provider(const char *path, dds_qos_provider_t **provider)

Initialize Qos Provider.

Create dds_qos_provider with provided system definition file path.

Parameters:
  • path[in] - String that contains system definition inself or path to system defenition file.

  • provider[inout] - Pointer to the Qos Provider structure.

Returns:

a DDS return code

dds_return_t dds_create_qos_provider_scope(const char *path, dds_qos_provider_t **provider, const char *key)

Initialize Qos Provider with certain scope.

Create dds_qos_provider with provided system definition file path and scope.

Parameters:
  • path[in] - String that contains system definition inself or path to system defenition file.

  • provider[inout] - Pointer to the Qos Provider structure.

  • key[in] - String that contains pattern of interested qos from path in format ‘<library name>::<profile name>::<entity name>’.

Returns:

a DDS return code

dds_return_t dds_qos_provider_get_qos(const dds_qos_provider_t *provider, dds_qos_kind_t type, const char *key, const dds_qos_t **qos)

Get Qos from Qos Provider.

Provide access to dds_qos_t from dds_qos_provider by full key and type of qos entity.

Parameters:
  • provider[in] - Pointer to the Qos Provider structure.

  • type[in] - Type of entity which Qos to get.

  • key[in] - Full qualify name of Qos to get in format ‘<library name>::<profile name>::<entity name>’.

  • qos[inout] - Pointer to the Qos structure.

Returns:

a DDS return code

void dds_delete_qos_provider(dds_qos_provider_t *provider)

Finalize Qos Provider.

Release resources allocated by dds_qos_provider.

Parameters:
  • provider[in] - Pointer to the Qos Provider structure.