Skip to main content
Version: v1

IContainerRuntimeOptions Interface

Options for container runtime.

Signature​

export interface IContainerRuntimeOptions

Properties​

PropertyModifiersTypeDescription
enableOfflineLoadoptionalbooleanSave enough runtime state to be able to serialize upon request and load to the same state in a new container.
flushModeoptionalFlushModeSets the flush mode for the runtime. In Immediate flush mode the runtime will immediately send all operations to the driver layer, while in TurnBased the operations will be buffered and then sent them as a single batch at the end of the turn. By default, flush mode is TurnBased.
gcOptionsoptionalIGCRuntimeOptions
loadSequenceNumberVerificationoptional"close" | "log" | "bypass"Affects the behavior while loading the runtime when the data verification check which compares the DeltaManager sequence number (obtained from protocol in summary) to the runtime sequence number (obtained from runtime metadata in summary) finds a mismatch. 1. "close" (default) will close the container with an assertion. 2. "log" will log an error event to telemetry, but still continue to load. 3. "bypass" will skip the check entirely. This is not recommended.
summaryOptionsoptionalISummaryRuntimeOptions
useDataStoreAliasingoptionalbooleanShould the runtime use data store aliasing for creating root datastores. In case of aliasing conflicts, the runtime will raise an exception which does not effect the status of the container.

Property Details​

enableOfflineLoad​

Save enough runtime state to be able to serialize upon request and load to the same state in a new container.

Signature​

readonly enableOfflineLoad?: boolean;

Type: boolean

flushMode​

Sets the flush mode for the runtime. In Immediate flush mode the runtime will immediately send all operations to the driver layer, while in TurnBased the operations will be buffered and then sent them as a single batch at the end of the turn. By default, flush mode is TurnBased.

Signature​

readonly flushMode?: FlushMode;

Type: FlushMode

gcOptions​

Signature​

readonly gcOptions?: IGCRuntimeOptions;

Type: IGCRuntimeOptions

loadSequenceNumberVerification​

Affects the behavior while loading the runtime when the data verification check which compares the DeltaManager sequence number (obtained from protocol in summary) to the runtime sequence number (obtained from runtime metadata in summary) finds a mismatch. 1. "close" (default) will close the container with an assertion. 2. "log" will log an error event to telemetry, but still continue to load. 3. "bypass" will skip the check entirely. This is not recommended.

Signature​

readonly loadSequenceNumberVerification?: "close" | "log" | "bypass";

Type: "close" | "log" | "bypass"

summaryOptions​

Signature​

readonly summaryOptions?: ISummaryRuntimeOptions;

Type: ISummaryRuntimeOptions

useDataStoreAliasing​

Should the runtime use data store aliasing for creating root datastores. In case of aliasing conflicts, the runtime will raise an exception which does not effect the status of the container.

Signature​

readonly useDataStoreAliasing?: boolean;

Type: boolean