IConnectionDetails Interface

Contract representing the result of a newly established connection to the server for syncing deltas.

Signature

export interface IConnectionDetails

Properties

Property Details

checkpointSequenceNumber

Last known sequence number to ordering service at the time of connection.

Signature

checkpointSequenceNumber: number | undefined;

Remarks

It may lag behind the actual last sequence number (quite a bit, if the container is very active), but it’s the best information the client has to figure out how far behind it is, at least for “read” connections. “write” connections may use the client’s own “join” op to obtain similar information which is likely to be more up-to-date.

claims

Signature

claims: ITokenClaims;

clientId

The client’s unique identifier assigned by the service.

Signature

clientId: string;

Remarks

It is not stable across reconnections.

serviceConfiguration

Signature

serviceConfiguration: IClientConfiguration;