IDeltaConnection Interface

Interface to represent a connection to a delta notification stream.

Signature

export interface IDeltaConnection

Properties

Property	Type	Description
connected	boolean

Methods

Method	Modifiers	Return Type	Description
addedGCOutboundReference(srcHandle, outboundHandle)	optional	void	Called when a new outbound reference is added to another node. This is used by garbage collection to identify all references added in the system.
attach(handler)		void	Attaches a message handler to the delta connection
dirty()		void	Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock that needs to be part of the summary but does not generate ops.
submit(messageContent, localOpMetadata)		void	Send new messages to the server.

Property Details

connected

Signature

connected: boolean;

Type: boolean

Method Details

addedGCOutboundReference

Called when a new outbound reference is added to another node. This is used by garbage collection to identify all references added in the system.

Signature

addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;

Parameters

Parameter	Type	Description
srcHandle	IFluidHandle	The handle of the node that added the reference.
outboundHandle	IFluidHandle	The handle of the outbound node that is referenced.

attach

Attaches a message handler to the delta connection

Signature

attach(handler: IDeltaHandler): void;

Parameters

Parameter	Type	Description
handler	IDeltaHandler

dirty

Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock that needs to be part of the summary but does not generate ops.

Signature

dirty(): void;

submit

Send new messages to the server.

Signature

submit(messageContent: any, localOpMetadata: unknown): void;

Parameters

Parameter	Type	Description
messageContent	any	The content of the message to be sent.
localOpMetadata	unknown	The local metadata associated with the message. This is kept locally by the runtime and not sent to the server. It will be provided back when this message is acknowledged by the server. It will also be provided back when asked to resubmit the message.