Deprecated functionality

All functionality in this section is considered deprecated. They will generate warnings and could be removed in a major release.

group deprecated

Functions

dds_entity_t dds_find_topic_scoped(dds_find_scope_t scope, dds_entity_t participant, const char *name, dds_duration_t timeout)

Deprecated:

Finds a locally created or discovered remote topic by topic name

Use dds_find_topic instead.

Finds a locally created topic or a discovered remote topic based on the topic name. In case the topic is not found, this function will wait for the topic to become available until the provided time out.

In case multiple (discovered) topics exist with the provided name, this function will return randomly one of these topic. The caller can decide to read DCPSTopic data and select one of the topic definitions to create the topic.

The returned topic should be released with dds_delete.

Parameters

  • scope – [in] The scope used to find the topic

  • participant – [in] The handle of the participant the found topic will be created in

  • name – [in] The name of the topic to find.

  • timeout – [in] The timeout for waiting for the topic to become available

Return values

  • >0 – A valid topic handle.

  • 0 – No topic of this name existed yet

  • DDS_RETCODE_BAD_PARAMETER – Participant handle or scope invalid

Returns

A valid topic handle or an error code.

bool dds_is_loan_available(const dds_entity_t entity)

Check if a Loan is available to reader/writer.

Deprecated:

Use dds_request_loan instead, returns 0 if loan is not available

The loan is available if the shared memory is enabled and all the constraints to enable shared memory are met and the type is fixed

Note

dds_loan_sample can be used if and only if dds_is_loan_available returns true.

Parameters

  • entity – [in] the handle of the entity

Returns

loan available or not

dds_return_t dds_loan_sample(dds_entity_t writer, void **sample)

Loan a sample from the writer.

Deprecated:

Use dds_request_loan

Note

This function is to be used with dds_write to publish the loaned sample.

Note

The function can only be used if dds_is_loan_available is true for the writer.

Parameters

  • writer – [in] the writer to loan the buffer from

  • sample – [out] the loaned sample

Returns

DDS_RETCODE_OK if successful, DDS_RETCODE_ERROR otherwise