Packages > @fluidframework/container-definitions > IDeltaManager

IDeltaManager Interface

Manages the transmission of ops between the runtime and storage.

Signature 

/** @sealed */
export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender

Extends: IEventProvider <IDeltaManagerEvents >, IDeltaSender

Type Parameters

Parameter Description
T
U

Properties

Property Alerts Modifiers Type Description
active readonly boolean Flag to indicate whether the client can write or not.
clientDetails readonly IClientDetails Details of client
hasCheckpointSequenceNumber readonly boolean Tells if current connection has checkpoint information. I.e. we know how far behind the client was at the time of establishing connection
inbound DEPRECATED readonly IDeltaQueue<T> The queue of inbound delta messages
inboundSignal readonly IDeltaQueue<ISignalMessage> The queue of inbound delta signals
initialSequenceNumber readonly number The initial sequence number set when attaching the op handler
lastKnownSeqNumber readonly number The latest sequence number the delta manager is aware of
lastMessage readonly ISequencedDocumentMessage | undefined The last message processed by the delta manager
lastSequenceNumber readonly number The last sequence number processed by the delta manager
maxMessageSize readonly number Max message size allowed to the delta manager
minimumSequenceNumber readonly number The current minimum sequence number
outbound DEPRECATED readonly IDeltaQueue<U[]> The queue of outbound delta messages
readOnlyInfo readonly ReadOnlyInfo
serviceConfiguration readonly IClientConfiguration | undefined Service configuration provided by the service.
version readonly string Protocol version being used to communicate with the service

Methods

Method Return Type Description
submitSignal(content, targetClientId) void Submit a signal to the service to be broadcast to other connected clients, but not persisted

Property Details

active

Flag to indicate whether the client can write or not.

Signature 

readonly active: boolean;

clientDetails

Details of client

Signature 

readonly clientDetails: IClientDetails;

hasCheckpointSequenceNumber

Tells if current connection has checkpoint information. I.e. we know how far behind the client was at the time of establishing connection

Signature 

readonly hasCheckpointSequenceNumber: boolean;

inbound

The queue of inbound delta messages

API This

Do not use, for internal use only. There are a lot of complications in core pieces of the runtime may break if this is used directly. For example summarization and op processing.

Signature 

readonly inbound: IDeltaQueue<T>;

inboundSignal

The queue of inbound delta signals

Signature 

readonly inboundSignal: IDeltaQueue<ISignalMessage>;

initialSequenceNumber

The initial sequence number set when attaching the op handler

Signature 

readonly initialSequenceNumber: number;

lastKnownSeqNumber

The latest sequence number the delta manager is aware of

Signature 

readonly lastKnownSeqNumber: number;

lastMessage

The last message processed by the delta manager

Signature 

readonly lastMessage: ISequencedDocumentMessage | undefined;

lastSequenceNumber

The last sequence number processed by the delta manager

Signature 

readonly lastSequenceNumber: number;

maxMessageSize

Max message size allowed to the delta manager

Signature 

readonly maxMessageSize: number;

minimumSequenceNumber

The current minimum sequence number

Signature 

readonly minimumSequenceNumber: number;

outbound

The queue of outbound delta messages

API This

Do not use, for internal use only. There are a lot of complications in core pieces of the runtime may break if this is used directly. For example op submission

Signature 

readonly outbound: IDeltaQueue<U[]>;

readOnlyInfo

Signature 

readonly readOnlyInfo: ReadOnlyInfo;

serviceConfiguration

Service configuration provided by the service.

Signature 

readonly serviceConfiguration: IClientConfiguration | undefined;

version

Protocol version being used to communicate with the service

Signature 

readonly version: string;

Method Details

submitSignal

Submit a signal to the service to be broadcast to other connected clients, but not persisted

Signature 

submitSignal(content: any, targetClientId?: string): void;

Parameters

Parameter Modifiers Type Description
content any
targetClientId optional string