Function dds_dispose_ts

Function Documentation

dds_return_t dds_dispose_ts(dds_entity_t writer, const void *data, dds_time_t timestamp)

This operation disposes an instance with a specific timestamp, identified by the data sample.

This operation performs the same functions as dds_dispose except that the application provides the value for the source_timestamp that is made available to connected reader objects. This timestamp is important for the interpretation of the destination_order QoS policy.

Parameters

  • writer – [in] The writer to dispose the data instance from.

  • data – [in] The data sample that identifies the instance to be disposed.

  • timestamp – [in] The timestamp used as source timestamp.

Return values

  • DDS_RETCODE_OK – The sample is written and the instance is marked for deletion

  • DDS_RETCODE_ERROR – An internal error has occurred

  • DDS_RETCODE_BAD_PARAMETER – At least one of the arguments is invalid

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted

  • DDS_RETCODE_TIMEOUT – Either the current action overflowed the available resources as specified by the combination of the reliability QoS policy, history QoS policy and resource_limits QoS policy, or the current action was waiting for data delivery acknowledgment by synchronous readers. This caused blocking of this operation, which could not be resolved before max_blocking_time of the reliability QoS policy elapsed.

Returns

A dds_return_t indicating success or failure.