IDeltaManager Interface

Packages > @fluidframework/container-definitions > IDeltaManager

Manages the transmission of ops between the runtime and storage.

Signature:

export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable 

Extends: IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable

Properties

List of properties of this interface
Property Type Description
active boolean Flag to indicate whether the client can write or not.
clientDetails IClientDetails Details of client
hasCheckpointSequenceNumber 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 IDeltaQueue The queue of inbound delta messages
inboundSignal IDeltaQueue<ISignalMessage> The queue of inbound delta signals
initialSequenceNumber number The initial sequence number set when attaching the op handler
lastKnownSeqNumber number The latest sequence number the delta manager is aware of
lastMessage ISequencedDocumentMessage | undefined The last message processed by the delta manager
lastSequenceNumber number The last sequence number processed by the delta manager
maxMessageSize number Max message size allowed to the delta manager
minimumSequenceNumber number The current minimum sequence number
outbound IDeltaQueue The queue of outbound delta messages
readonly boolean Tells if container is in read-only mode. Data stores should listen for "readonly" notifications and disallow user making changes to data stores. Readonly state can be because of no storage write permission, or due to host forcing readonly mode for container.We do not differentiate here between no write access to storage vs. host disallowing changes to container - in all cases container runtime and data stores should respect readonly state and not allow local changes.It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.
readOnlyInfo ReadOnlyInfo
serviceConfiguration IClientConfiguration | undefined Service configuration provided by the service.
version string Protocol version being used to communicate with the service

Methods

List of methods of this class
Method Description
close() Terminate the connection to storage
submitSignal(content) Submit a signal to the service to be broadcast to other connected clients, but not persisted

Events

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

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

Signature:

readonly outbound: IDeltaQueue<U[]>;

readonly

Warning: This API is now obsolete.

  • use readOnlyInfo

Tells if container is in read-only mode. Data stores should listen for “readonly” notifications and disallow user making changes to data stores. Readonly state can be because of no storage write permission, or due to host forcing readonly mode for container.

We do not differentiate here between no write access to storage vs. host disallowing changes to container - in all cases container runtime and data stores should respect readonly state and not allow local changes.

It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.

Signature:

readonly readonly?: boolean;

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;

Methods

close

Terminate the connection to storage

Signature:

close(): void;

Returns:

void

submitSignal

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

Signature:

submitSignal(content: any): void;

Parameters

List of parameters
Parameter Type Description
content any

Returns:

void