Caplin Systems - getLatency Method (timeStampField)

Gets the latency of the record in milliseconds. StreamLink calculates the latency using the clock offset and the timestamp supplied in the timeStampField field of the record.

Declaration Syntax

Visual Basic

Visual C++

long getLatency(
	string timeStampField
)

Function getLatency ( _
	timeStampField As String _
) As Long

long long getLatency(
	String^ timeStampField
)

Parameters

timeStampField (String): The name of the field in the record containing the timestamp that StreamLink uses to calculate the latency of the record.

Return Value

The latency of the record in milliseconds, or -1 if the latency cannot be calculated.

Remarks

The latency cannot be calculated if timeStampField is not present in the record or if the clock offset has not yet been established. For further information, see Clock Offset and Latency Measurement

Assembly: Caplin.StreamLink (Module: Caplin.StreamLink) Version: 5.0.23.0 (5.0.23.0)