@fluidframework/runtime-definitions Package

Packages > @fluidframework/runtime-definitions

Enumerations

List of enums contained in this package or namespace
Enumeration Description
CreateSummarizerNodeSource
FlushMode Runtime flush mode handling

Interfaces

List of interfaces contained in this package or namespace
Interface Description
IAttachMessage Message send by client attaching local data structure. Contains snapshot of data structure which is the current state of this data structure.
IChannelSummarizeResult
IContainerRuntimeBase A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need TODO: this should be merged into IFluidDataStoreContext
IContainerRuntimeBaseEvents
IContextSummarizeResult
IEnvelope An envelope wraps the contents with the intended target
IFluidDataStoreChannel Minimal interface a data store runtime need to provide for IFluidDataStoreContext to bind to controlFunctionality include attach, snapshot, op/signal processing, request routes, and connection state notifications
IFluidDataStoreContext Represents the context for the data store. It is used by the data store runtime to get information and call functionality to the container.
IFluidDataStoreContextDetached
IFluidDataStoreContextEvents
IFluidDataStoreFactory IFluidDataStoreFactory create data stores. It is associated with an identifier (its type member) and usually provided to consumers using this mapping through a data store registry.
IFluidDataStoreRegistry An association of identifiers to data store registry entries, where the entries can be used to create data stores.
IGarbageCollectionData Represents the garbage collection data returned by each node in the Container. It is used for running GC in a document.
IGarbageCollectionSummaryDetails Represents the format of the GC details that is stored in the summary for each node.
IInboundSignalMessage Represents ISignalMessage with its type.
IProvideFluidDataStoreFactory
IProvideFluidDataStoreRegistry
ISignalEnvelope
ISummarizeInternalResult
ISummarizeResult
ISummarizerNode
ISummarizerNodeConfig
ISummarizerNodeConfigWithGC
ISummarizerNodeWithGC Extends the functionality of ISummarizerNode to support garbage collection. It adds / udpates the following APIs: - usedRoutes - The routes in this node that are currently in use. - getGCData - A new API that can be used to get the garbage collection data for this node. - summarize - Added a trackState flag which indicates whether the summarizer node should track the state of the summary or not. - createChild - Added the following params: - getGCDataFn - This gets the GC data from the caller. This must be provided in order for getGCData to work. - getInitialGCDetailsFn - This gets the initial GC details from the caller. - isReferenced - This tells whether this node is referenced in the document or not. - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.
ISummaryStats
ISummaryTreeWithStats

Variables

List of variables contained in this package or namespace
Variable Description
channelsTreeName
gcBlobKey
IFluidDataStoreFactory
IFluidDataStoreRegistry

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
CreateChildSummarizerNodeFn
CreateChildSummarizerNodeParam
FluidDataStoreRegistryEntry A single registry entry that may be used to create data stores It has to have either factory or registry, or both.
InboundAttachMessage This type should be used when reading an incoming attach op, but it should not be used when creating a new attach op. Older versions of attach messages could have null snapshots, so this gives correct typings for writing backward compatible code.
NamedFluidDataStoreRegistryEntries An iterable identifier/registry entry pair list
NamedFluidDataStoreRegistryEntry An associated pair of an identifier and registry entry. Registry entries may be dynamically loaded.
SummarizeInternalFn

Enumerations

CreateSummarizerNodeSource enum

Signature:

export declare enum CreateSummarizerNodeSource

Enumeration Members

List of members in use in this enum
Member Value Description
FromAttach 1
FromSummary 0
Local 2

FlushMode enum

Runtime flush mode handling

Signature:

export declare enum FlushMode

Enumeration Members

List of members in use in this enum
Member Value Description
Automatic 0 In automatic flush mode the runtime will immediately send all operations to the driver layer.
Manual 1 When in manual flush mode the runtime will buffer operations in the current turn and send them as a single batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.

Variables

channelsTreeName

Signature:

channelsTreeName = ".channels"

gcBlobKey

Signature:

gcBlobKey = "gc"

IFluidDataStoreFactory

Signature:

IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory

IFluidDataStoreRegistry

Signature:

IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry

Type Aliases

CreateChildSummarizerNodeFn

Signature:

export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>, getInitialGCSummaryDetailsFn: () => Promise<IGarbageCollectionSummaryDetails>) => ISummarizerNodeWithGC;

CreateChildSummarizerNodeParam

Signature:

export declare type CreateChildSummarizerNodeParam = {
    type: CreateSummarizerNodeSource.FromSummary;
} | {
    type: CreateSummarizerNodeSource.FromAttach;
    sequenceNumber: number;
    snapshot: ITree;
} | {
    type: CreateSummarizerNodeSource.Local;
};

FluidDataStoreRegistryEntry

A single registry entry that may be used to create data stores It has to have either factory or registry, or both.

Signature:

export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;

InboundAttachMessage

This type should be used when reading an incoming attach op, but it should not be used when creating a new attach op. Older versions of attach messages could have null snapshots, so this gives correct typings for writing backward compatible code.

Signature:

export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
    snapshot: IAttachMessage["snapshot"] | null;
};

NamedFluidDataStoreRegistryEntries

An iterable identifier/registry entry pair list

Signature:

export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;

NamedFluidDataStoreRegistryEntry

An associated pair of an identifier and registry entry. Registry entries may be dynamically loaded.

Signature:

export declare type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];

SummarizeInternalFn

Signature:

export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>;