IDeltaManager Interface

Events

active

Flag to indicate whether the client can write or not.

Signature:

readonly active: boolean;

clientDetails

Details of client

Signature:

readonly clientDetails: IClientDetails;

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;

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

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;

serviceConfiguration

Service configuration provided by the service.

Signature:

readonly serviceConfiguration: IServiceConfiguration | 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

Returns:

void