|
DataReaderWaitForHistoricalData Method
|
Namespace:
OpenDDSharp.DDS
Assembly:
OpenDDSharp (in OpenDDSharp.dll) Version: 0.5.0.0
Syntax public ReturnCode WaitForHistoricalData(
Duration maxWait
)
Public Function WaitForHistoricalData (
maxWait As Duration
) As ReturnCode
public:
ReturnCode WaitForHistoricalData(
Duration maxWait
)
member WaitForHistoricalData :
maxWait : Duration -> ReturnCode
Parameters
- maxWait
- Type: OpenDDSharp.DDSDuration
The maximum Duration time to wait for the historical data.
Return Value
Type:
ReturnCodeThe
ReturnCode that indicates the operation result.
Remarks
The operation WaitForHistoricalData blocks the calling thread until either all "historical" data is received, or else the
duration specified by the maxWait parameter elapses, whichever happens first. A return value of
Ok indicates that all the
"historical" data was received; a return value of
Timeout indicates that maxWait elapsed before all the data was received.
See Also