IDeltaHandler Interface
Packages > @fluidframework/datastore-definitions > IDeltaHandler
Handler provided by shared data structure to process requests from the runtime.
Signature:
export interface IDeltaHandler
Properties
| Property | Type | Description |
|---|---|---|
| process | (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void | Processes the op. |
Methods
| Method | Description |
|---|---|
| reSubmit(message, localOpMetadata) | Called when the runtime asks the client to resubmit an op. This may be because the Container reconnected and this op was not acked. The client can choose to resubmit the same message, submit different / multiple messages or not submit anything at all. |
| setConnectionState(connected) | State change events to indicate changes to the delta connection |
Events
process
Processes the op.
Signature:
process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;
Methods
reSubmit
Called when the runtime asks the client to resubmit an op. This may be because the Container reconnected and this op was not acked. The client can choose to resubmit the same message, submit different / multiple messages or not submit anything at all.
Signature:
reSubmit(message: any, localOpMetadata: unknown): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| message | any | The original message that was submitted. |
| localOpMetadata | unknown | The local metadata associated with the original message. |
Returns:
void
setConnectionState
State change events to indicate changes to the delta connection
Signature:
setConnectionState(connected: boolean): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| connected | boolean | true if connected, false otherwise |
Returns:
void