IConnectionDetails Interface

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

Signature

export interface IConnectionDetails

Properties

Property	Type	Description
checkpointSequenceNumber	number | undefined	Last known sequence number to ordering service at the time of connection It may lap actual last sequence number (quite a bit, if container is very active). But it's best information for client to figure out how far it is behind, at least for "read" connections. "write" connections may use own "join" op to similar information, that is likely to be more up-to-date.
claims	ITokenClaims
clientId	string
existing	boolean
initialClients	ISignalClient[]
mode	ConnectionMode
serviceConfiguration	IClientConfiguration
version	string

Property Details

checkpointSequenceNumber

Last known sequence number to ordering service at the time of connection It may lap actual last sequence number (quite a bit, if container is very active). But it's best information for client to figure out how far it is behind, at least for "read" connections. "write" connections may use own "join" op to similar information, that is likely to be more up-to-date.

Signature

checkpointSequenceNumber: number | undefined;

Type: number | undefined

claims

Signature

claims: ITokenClaims;

Type: ITokenClaims

clientId

Signature

clientId: string;

Type: string

existing

Signature

existing: boolean;

Type: boolean

initialClients

Signature

initialClients: ISignalClient[];

Type: ISignalClient[]

mode

Signature

mode: ConnectionMode;

Type: ConnectionMode

serviceConfiguration

Signature

serviceConfiguration: IClientConfiguration;

Type: IClientConfiguration

version

Signature

version: string;

Type: string