Function dds_suspend

Function Documentation

dds_return_t dds_suspend(dds_entity_t publisher)

Suspends the publications of the Publisher.

This operation is a hint to the Service so it can optimize its performance by e.g., collecting modifications to DDS writers and then batching them. The Service is not required to use the hint.

Every invocation of this operation must be matched by a corresponding call to

See also

dds_resume indicating that the set of modifications has completed.

Parameters

  • publisher – [in] The publisher for which all publications will be suspended.

Return values

  • DDS_RETCODE_OK – Publications suspended successfully.

  • DDS_RETCODE_BAD_PARAMETER – The pub parameter is not a valid publisher.

  • DDS_RETCODE_UNSUPPORTED – Operation is not supported.

Returns

A dds_return_t indicating success or failure.