Function dds_reader_wait_for_historical_data

• Defined in File dds.h

Function Documentation

dds_return_t dds_reader_wait_for_historical_data(dds_entity_t reader, dds_duration_t max_wait)

Wait until reader receives all historic data.

The operation blocks the calling thread until either all “historical” data is received, or else the duration specified by the max_wait parameter elapses, whichever happens first. A return value of 0 indicates that all the “historical” data was received; a return value of TIMEOUT indicates that max_wait elapsed before all the data was received.

Parameters

• reader – [in] The reader on which to wait for historical data.

• max_wait – [in] How long to wait for historical data before time out.

Returns

a status, 0 on success, TIMEOUT on timeout or a negative value to indicate error.