IConnected Interface

Packages > @fluidframework/protocol-definitions > IConnected

Message sent to indicate a client has connected to the server

Signature:

export interface IConnected 

Properties

List of properties of this interface
Property Type Description
checkpointSequenceNumber number 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 Claims for the client
clientId string The client who is sending the message
epoch string Represents the version of document at server.
existing boolean Whether or not this is an existing document
initialClients ISignalClient[] Prior clients already connected.
initialMessages ISequencedDocumentMessage[] Messages sent during the connection
initialSignals ISignalMessage[] Signals sent during the connection
maxMessageSize number Maximum size of a message before chunking is required
mode ConnectionMode Connection mode of client.
nonce string An optional nonce used during connection to identify connection attempts
serviceConfiguration IClientConfiguration Configuration details provided by the service
supportedVersions string[] List of protocol versions supported by the server
version string Protocol version selected by the server to communicate with the client

Events

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;

claims

Claims for the client

Signature:

claims: ITokenClaims;

clientId

The client who is sending the message

Signature:

clientId: string;

epoch

Represents the version of document at server.

Signature:

epoch?: string;

existing

Whether or not this is an existing document

Signature:

existing: boolean;

initialClients

Prior clients already connected.

Signature:

initialClients: ISignalClient[];

initialMessages

Messages sent during the connection

Signature:

initialMessages: ISequencedDocumentMessage[];

initialSignals

Signals sent during the connection

Signature:

initialSignals: ISignalMessage[];

maxMessageSize

Maximum size of a message before chunking is required

Signature:

maxMessageSize: number;

mode

Connection mode of client.

Signature:

mode: ConnectionMode;

nonce

An optional nonce used during connection to identify connection attempts

Signature:

nonce?: string;

serviceConfiguration

Configuration details provided by the service

Signature:

serviceConfiguration: IClientConfiguration;

supportedVersions

List of protocol versions supported by the server

Signature:

supportedVersions: string[];

version

Protocol version selected by the server to communicate with the client

Signature:

version: string;