StreamLink.NET
6.2.8-3489-2f7a95d
|
Provides information about a change to type 1 data (fieldname and data pairs) in a record. More...
Public Member Functions | |
long | GetLatency (string 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. More... | |
Properties | |
IDictionary< string, string > | Fields [get] |
Returns the record fields relating to the event, as a collection of key-value pairs. More... | |
long | TimeReceived [get] |
Returns the time that the record data in the event was received at the client. More... | |
Properties inherited from Caplin.StreamLink.IDataEvent | |
bool | IsImage [get] |
Returns whether this was an image event or an update event. More... | |
string | Subject [get] |
Returns the subject to which the event relates. More... | |
Provides information about a change to type 1 data (fieldname and data pairs) in a record.
The RecordType1Event is provided in an onRecordUpdate callback to a ISubscriptionListener.
long Caplin.StreamLink.IRecordType1Event.GetLatency | ( | string | 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.
The latency cannot be calculated if timeStampField
is not present in the record or if the clock offset has not yet been established.
timeStampField | The name of the field in the record containing the timestamp that StreamLink uses to calculate the latency of the record. |
|
get |
Returns the record fields relating to the event, as a collection of key-value pairs.
When a call to isImage() returns true, the subscription data event contains an image of the data for the subscribed item. All the fields comprising the record are present in the collection. The application must discard any values previously received and replace them with the values contained within the collection.
When a call to isImage() returns false, the subscription data event contains new data for the subscribed record. The values in the collection returned are an update to any values previously received and any application caches should be updated appropriately.
the fields
|
get |
Returns the time that the record data in the event was received at the client.
The time that the record data was received at the client in milliseconds since 1 January 1970 00:00:00 UTC.