@fluidframework/container-runtime Package

Packages > @fluidframework/container-runtime

Classes

List of classes contained in this package or namespace
Class Description
ContainerRuntime Represents the runtime of the container. Contains helper functions/state of the container. It will define the store level mappings.
DeltaScheduler DeltaScheduler is responsible for the scheduling of inbound delta queue in cases where there is more than one op a particular run of the queue. It does not schedule if there is just one op or just one batch in the run. It does the following two things: 1. If the ops have been processed for more than a specific amount of time, it pauses the queue and calls setTimeout to schedule a resume of the queue. This ensures that we don't block the JS thread for a long time processing ops synchronously (for example, when catching up ops right after boot or catching up ops / delayed realizing data stores by summarizer). 2. If we scheduled a particular run of the queue, it logs telemetry for the number of ops processed, the time and number of turns it took to process the ops.
FluidDataStoreRegistry
RunningSummarizer An instance of RunningSummarizer manages the heuristics for summarizing. Until disposed, the instance of RunningSummarizer can assume that it is in a state of running, meaning it is connected and initialized. It keeps track of summaries that it is generating as they are broadcast and acked/nacked.
RunWhileConnectedCoordinator Helper class to coordinate something that needs to run only while connected. This provides promises that resolve as it starts or stops. Stopping happens when disconnected or if stop() is called.
ScheduleManager
Summarizer Summarizer is responsible for coordinating when to send generate and send summaries. It is the main entry point for summary work.
SummarizingWarning
SummaryCollection Data structure that looks at the op stream to track summaries as they are broadcast, acked and nacked. It provides functionality for watching specific summaries.

Enumerations

List of enums contained in this package or namespace
Enumeration Description
ContainerMessageType

Functions

List of functions contained in this package or namespace
Function Description
isRuntimeMessage(message)
unpackRuntimeMessage(message)

Interfaces

List of interfaces contained in this package or namespace
Interface Description
ContainerRuntimeMessage
IAckedSummary A single summary which has already been acked by the server.
IChunkedOp
IClientSummaryWatcher Watches summaries created by a specific client.
IConnectableRuntime
IContainerRuntimeOptions Options for container runtime.
IGeneratedSummaryData
INotStartedResult Start result indicating that the start was not successful.
IPreviousState
IProvideSummarizer
IStartedResult Start result indicating that the start was successful.
ISubmittedSummaryData
ISummarizer
ISummarizerEvents
ISummarizerRuntime
ISummarizingWarning
ISummary A single summary which can be tracked as it goes through its life cycle. The life cycle is: Local to Broadcast to Acked/Nacked.
ISummaryAckMessage Interface for summary ack messages with typed contents.
ISummaryAttempt Data about a summary attempt
ISummaryNackMessage Interface for summary nack messages with typed contents.
ISummaryOpMessage Interface for summary op messages with typed contents.
IUnsubmittedSummaryData
IUploadedSummaryData

Variables

List of variables contained in this package or namespace
Variable Description
createSummarizingWarning
ISummarizer
taskSchedulerId

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
GenerateSummaryData

Enumerations

ContainerMessageType enum

Signature:

export declare enum ContainerMessageType 

Enumeration Members

List of members in use in this enum
Member Value Description
Attach "attach"
BlobAttach "blobAttach"
ChunkedOp "chunkedOp"
FluidDataStoreOp "component"

Functions

isRuntimeMessage

Signature:

export declare function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;

Parameters

List of parameters
Parameter Type Description
message ISequencedDocumentMessage

Returns:

boolean

unpackRuntimeMessage

Signature:

export declare function unpackRuntimeMessage(message: ISequencedDocumentMessage): ISequencedDocumentMessage;

Parameters

List of parameters
Parameter Type Description
message ISequencedDocumentMessage

Returns:

ISequencedDocumentMessage

Variables

createSummarizingWarning

Signature:

createSummarizingWarning: (details: string, logged: boolean) => SummarizingWarning

ISummarizer

Signature:

ISummarizer: keyof IProvideSummarizer

taskSchedulerId

Signature:

taskSchedulerId = "_scheduler"

Type Aliases

GenerateSummaryData

Signature:

export declare type GenerateSummaryData = IUnsubmittedSummaryData | ISubmittedSummaryData;