Function dds_assert_liveliness

Function Documentation

dds_return_t dds_assert_liveliness(dds_entity_t entity)

This operation manually asserts the liveliness of a writer or domain participant.

This operation manually asserts the liveliness of a writer or domain participant. This is used in combination with the Liveliness QoS policy to indicate that the entity remains active. This operation need only be used if the liveliness kind in the QoS is either DDS_LIVELINESS_MANUAL_BY_PARTICIPANT or DDS_LIVELINESS_MANUAL_BY_TOPIC.

Parameters

entity – [in] A domain participant or writer

Return values

  • DDS_RETCODE_OK – The operation was successful.

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.

Returns

A dds_return_t indicating success or failure.