Function dds_refresh_statistics

Function Documentation

dds_return_t dds_refresh_statistics(struct dds_statistics *stat)

Update a previously created statistics structure with current values.

Only the time stamp and the values (and “opaque”) may change. The set of keys and the types of the values do not change.

Parameters
  • stat[inout] statistics structure to update the values of

Return values
  • DDS_RETCODE_OK – the data was successfully updated

  • DDS_RETCODE_BAD_PARAMETER – stats is a null pointer or the referenced entity no longer exists

  • DDS_RETCODE_PRECONDITION_NOT_MET – library was deinitialized

Returns

success or an error indication