@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
IAgentScheduler Agent scheduler distributes a set of tasks/variables across connected clients.
IAttachMessage Message send by client attaching local data structure. Contains snapshot of data structure which is the current state of this data structure.
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
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
IFluidDataStoreContextType
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.
IInboundSignalMessage Represents ISignalMessage with its type.
IProvideAgentScheduler
IProvideFluidDataStoreFactory
IProvideFluidDataStoreRegistry
IProvideTaskManager
ISignalEnvelop
ISummarizeInternalResult
ISummarizeResult
ISummarizerNode
ISummarizerNodeConfig
ISummaryStats
ISummaryTracker
ISummaryTreeWithStats
ITask Definition of a Task.
ITaskManager Task manager enables app to register and pick tasks.

Variables

List of variables contained in this package or namespace
Variable Description
IAgentScheduler
IFluidDataStoreFactory
IFluidDataStoreRegistry
ITaskManager

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 back-compat code.
NamedFluidDataStoreRegistryEntries An iterable itentifier/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

IAgentScheduler

Signature:

IAgentScheduler: keyof IProvideAgentScheduler

IFluidDataStoreFactory

Signature:

IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory

IFluidDataStoreRegistry

Signature:

IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry

ITaskManager

Signature:

ITaskManager: keyof IProvideTaskManager

Type Aliases

CreateChildSummarizerNodeFn

Signature:

export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn) => ISummarizerNode;

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 back-compat code.

Signature:

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

NamedFluidDataStoreRegistryEntries

An iterable itentifier/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) => Promise<ISummarizeInternalResult>;