Skip to main content

MockContainerRuntimeForReconnection Class

Specialized implementation of MockContainerRuntime for testing ops during reconnection.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/test-runtime-utils/legacy.

For more information about our API support guarantees, see here.

Signature​

export declare class MockContainerRuntimeForReconnection extends MockContainerRuntime

Extends: MockContainerRuntime

Constructors​

Constructor Alerts Description
(constructor)(dataStoreRuntime, factory, runtimeOptions, overrides) Alpha Constructs a new instance of the MockContainerRuntimeForReconnection class

Properties​

Property Alerts Modifiers Type Description
connected Alpha boolean Returns the connection state of the container runtime. Any messages that are submitted while not connected will be resubmitted via the resubmit flow on reconnection. Any messages received while disconnected will be processed on reconnection. Also, the clientId of the runtime will change on reconnection.
factory Alpha readonly MockContainerRuntimeFactoryForReconnection
pendingRemoteMessages Alpha readonly ISequencedDocumentMessage[] Contains messages from other clients that were sequenced while this runtime was marked as disconnected.
processedOps Alpha optional, readonly ISequencedDocumentMessage[]

Constructor Details​

(constructor)​

Constructs a new instance of the MockContainerRuntimeForReconnection class

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

constructor(dataStoreRuntime: MockFluidDataStoreRuntime, factory: MockContainerRuntimeFactoryForReconnection, runtimeOptions?: IMockContainerRuntimeOptions, overrides?: {
        minimumSequenceNumber?: number;
        trackRemoteOps?: boolean;
    });

Parameters​

Parameter Modifiers Type Description
dataStoreRuntime MockFluidDataStoreRuntime
factory MockContainerRuntimeFactoryForReconnection
runtimeOptions optional IMockContainerRuntimeOptions
overrides optional { minimumSequenceNumber?: number; trackRemoteOps?: boolean; }

Property Details​

connected​

Returns the connection state of the container runtime. Any messages that are submitted while not connected will be resubmitted via the resubmit flow on reconnection. Any messages received while disconnected will be processed on reconnection. Also, the clientId of the runtime will change on reconnection.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

get connected(): boolean;
set connected(connected: boolean);

Type: boolean

factory​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

protected readonly factory: MockContainerRuntimeFactoryForReconnection;

Type: MockContainerRuntimeFactoryForReconnection

pendingRemoteMessages​

Contains messages from other clients that were sequenced while this runtime was marked as disconnected.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

protected readonly pendingRemoteMessages: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

processedOps​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

protected readonly processedOps?: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]