IContainerRuntimeBase Interface

Packages > @fluidframework/runtime-definitions > 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

Signature

/** @sealed */
export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents>

Extends: IEventProvider <IContainerRuntimeBaseEvents >

Properties

Methods

Property Details

baseLogger

Signature

readonly baseLogger: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

clientDetails

Signature

readonly clientDetails: IClientDetails;

Type: IClientDetails

disposed

Signature

readonly disposed: boolean;

Type: boolean

submitSignal

Submits a container runtime level signal to be sent to other clients.

Signature

submitSignal: (type: string, content: unknown, targetClientId?: string) => void;

Type: (type: string, content: unknown, targetClientId?: string) => void

Method Details

_createDataStoreWithProps

Signature

_createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any, id?: string): Promise<IDataStore>;

Parameters

Returns

Return type: Promise<IDataStore >

createDataStore

Creates a data store and returns an object that exposes a handle to the data store’s entryPoint, and also serves as the data store’s router. The data store is not bound to a container, and in such state is not persisted to storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this store being attached to storage.

Signature

createDataStore(pkg: Readonly<string | string[]>, loadingGroupId?: string): Promise<IDataStore>;

Parameters

Returns

Return type: Promise<IDataStore >

createDetachedDataStore

Creates detached data store context. Only after context.attachRuntime() is called, data store initialization is considered complete.

Signature

createDetachedDataStore(pkg: Readonly<string[]>, loadingGroupId?: string): IFluidDataStoreContextDetached;

Parameters

Returns

Return type: IFluidDataStoreContextDetached

generateDocumentUniqueId

Generates a new ID that is guaranteed to be unique across all sessions for this container. It could be in compact form (non-negative integer, oppotunistic), but it could also be UUID string. UUIDs generated will have low entropy in groups and will compress well. It can be leveraged anywhere in container where container unique IDs are required, i.e. any place that uses uuid() and stores result in container is likely candidate to start leveraging this API. If you always want to convert to string, instead of doing String(generateDocumentUniqueId()), consider doing encodeCompactIdToString(generateDocumentUniqueId()).

For more details, please see IIdCompressor.generateDocumentUniqueId()

Signature

generateDocumentUniqueId(): number | string;

Returns

Return type: number | string

getAbsoluteUrl

Get an absolute url for a provided container-relative request. Returns undefined if the container or data store isn’t attached to storage.

Signature

getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;

Parameters

Returns

Return type: Promise<string | undefined>

getAliasedDataStoreEntryPoint

Returns the aliased data store’s entryPoint, given the alias.

Signature

getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;

Parameters

Returns

The data store’s entry point (@fluidframework/core-interfaces#IFluidHandle) if it exists and is aliased. Returns undefined if no data store has been assigned the given alias.

Return type: Promise<IFluidHandle <FluidObject > | undefined>

getAudience

Returns the current audience.

Signature

getAudience(): IAudience;

Returns

Return type: IAudience

getQuorum

Returns the current quorum.

Signature

getQuorum(): IQuorumClients;

Returns

Return type: IQuorumClients

getSnapshotForLoadingGroupId

Api to fetch the snapshot from the service for a loadingGroupIds.

Signature

getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{
        snapshotTree: ISnapshotTree;
        sequenceNumber: number;
    }>;

Parameters

Returns

• snapshotTree and the sequence number of the snapshot.

Return type: Promise<{ snapshotTree: ISnapshotTree ; sequenceNumber: number; }>

orderSequentially

Invokes the given callback and guarantees that all operations generated within the callback will be ordered sequentially.

If the callback throws an error, the container will close and the error will be logged.

Signature

orderSequentially(callback: () => void): void;

Parameters

uploadBlob

Signature

uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;

Parameters

Returns

Return type: Promise<IFluidHandle <ArrayBufferLike>>