IDeltaManager Interface

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

Type Parameters

Parameter	Description
T
U

Properties

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<T>	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<U[]>	The queue of outbound delta messages
readOnlyInfo	ReadOnlyInfo
serviceConfiguration	IClientConfiguration | undefined	Service configuration provided by the service.
version	string	Protocol version being used to communicate with the service

Methods

Method	Return Type	Description
submitSignal(content)	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;

Type: boolean

clientDetails

Details of client

Signature

readonly clientDetails: IClientDetails;

Type: 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;

Type: boolean

inbound

The queue of inbound delta messages

Signature

readonly inbound: IDeltaQueue<T>;

Type: IDeltaQueue<T>

inboundSignal

The queue of inbound delta signals

Signature

readonly inboundSignal: IDeltaQueue<ISignalMessage>;

Type: IDeltaQueue<ISignalMessage>

initialSequenceNumber

The initial sequence number set when attaching the op handler

Signature

readonly initialSequenceNumber: number;

Type: number

lastKnownSeqNumber

The latest sequence number the delta manager is aware of

Signature

readonly lastKnownSeqNumber: number;

Type: number

lastMessage

The last message processed by the delta manager

Signature

readonly lastMessage: ISequencedDocumentMessage | undefined;

Type: ISequencedDocumentMessage | undefined

lastSequenceNumber

The last sequence number processed by the delta manager

Signature

readonly lastSequenceNumber: number;

Type: number

maxMessageSize

Max message size allowed to the delta manager

Signature

readonly maxMessageSize: number;

Type: number

minimumSequenceNumber

The current minimum sequence number

Signature

readonly minimumSequenceNumber: number;

Type: number

outbound

The queue of outbound delta messages

Signature

readonly outbound: IDeltaQueue<U[]>;

Type: IDeltaQueue<U[]>

readOnlyInfo

Signature

readonly readOnlyInfo: ReadOnlyInfo;

Type: ReadOnlyInfo

serviceConfiguration

Service configuration provided by the service.

Signature

readonly serviceConfiguration: IClientConfiguration | undefined;

Type: IClientConfiguration | undefined

version

Protocol version being used to communicate with the service

Signature

readonly version: string;

Type: string

Method Details

submitSignal

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

Signature

submitSignal(content: any): void;

Parameters

Parameter	Type	Description
content	any