DeltaManager Class

Constructors

DeltaManager.(constructor)

Constructs a new instance of the DeltaManager class

Signature:

constructor(serviceProvider: () => IDocumentService | undefined, client: IClient, logger: ITelemetryLogger, reconnectAllowed: boolean);

Parameters

Properties

active

Signature:

get active(): boolean;

clientDetails

Signature:

readonly clientDetails: IClientDetails;

connectionMode

The current connection mode, initially write.

Signature:

get connectionMode(): ConnectionMode;

disposed

Signature:

get disposed(): boolean;

IDeltaSender

Signature:

get IDeltaSender(): this;

inbound

Signature:

get inbound(): IDeltaQueue<ISequencedDocumentMessage>;

inboundSignal

Signature:

get inboundSignal(): IDeltaQueue<ISignalMessage>;

initialSequenceNumber

Signature:

get initialSequenceNumber(): number;

lastKnownSeqNumber

Signature:

get lastKnownSeqNumber(): number;

lastSequenceNumber

Signature:

get lastSequenceNumber(): number;

maxMessageSize

Signature:

get maxMessageSize(): number;

minimumSequenceNumber

Signature:

get minimumSequenceNumber(): number;

outbound

Signature:

get outbound(): IDeltaQueue<IDocumentMessage[]>;

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. It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.

Signature:

get readonly(): boolean | undefined;

readonlyPermissions

Tells if user has no write permissions for file in storage It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.

Signature:

get readonlyPermissions(): boolean | undefined;

reconnectMode

Automatic reconnecting enabled or disabled. If set to Never, then reconnecting will never be allowed.

Signature:

get reconnectMode(): ReconnectMode;

referenceTerm

Signature:

get referenceTerm(): number;

scopes

Signature:

get scopes(): string[] | undefined;

serviceConfiguration

Signature:

get serviceConfiguration(): IServiceConfiguration | undefined;

socketDocumentId

Signature:

get socketDocumentId(): string | undefined;

version

Signature:

get version(): string;

Methods

attachOpHandler

Sets the sequence number from which inbound messages should be returned

Signature:

attachOpHandler(minSequenceNumber: number, sequenceNumber: number, term: number, handler: IDeltaHandlerStrategy): void;

Parameters

Returns:

void

close

Closes the connection and clears inbound & outbound queues.

Signature:

close(error?: ICriticalContainerError): void;

Parameters

Returns:

void

connect

Signature:

connect(args?: IConnectionArgs): Promise<IConnectionDetails>;

Parameters

Returns:

Promise<IConnectionDetails>

dispose

Signature:

dispose(): void;

Returns:

void

flush

Signature:

flush(): void;

Returns:

void

forceReadonly

Sends signal to runtime (and data stores) to be read-only. Hosts may have read only views, indicating to data stores that no edits are allowed. This is independent from this._readonlyPermissions (permissions) and this.connectionMode (server can return “write” mode even when asked for “read”) Leveraging same “readonly” event as runtime & data stores should behave the same in such case as in read-only permissions. But this.active can be used by some DDSes to figure out if ops can be sent (for example, read-only view still participates in code proposals / upgrades decisions)

Signature:

forceReadonly(readonly: boolean): void;

Parameters

Returns:

void

setAutomaticReconnect

Enables or disables automatic reconnecting. Will throw an error if reconnectMode set to Never.

Signature:

setAutomaticReconnect(reconnect: boolean): void;

Parameters

Returns:

void

submit

Signature:

submit(type: MessageType, contents: any, batch?: boolean, metadata?: any): number;

Parameters

Returns:

number

submitSignal

Signature:

submitSignal(content: any): void;

Parameters

Returns:

void

updateQuorumJoin

Signature:

updateQuorumJoin(): void;

Returns:

void

updateQuorumLeave

Signature:

updateQuorumLeave(): void;

Returns:

void