RunningSummarizer Class

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

Signature:

export declare class RunningSummarizer implements IDisposable 

Implements: IDisposable

Properties

List of properties for this class
Property Modifiers Type Description
disposed boolean
tryGetCorrelatedLogger (summaryOpRefSeq: any) => ITelemetryLogger | undefined RunningSummarizer's logger includes the sequenced index of the current summary on each event. If some other Summarizer code wants that event on their logs they can get it here, but only if they're logging about that same summary.

Methods

List of methods on this class
Method Modifiers Description
dispose()
handleOp(error, op)
handleSystemOp(op)
start(clientId, onBehalfOfClientId, logger, summaryWatcher, configuration, internalsProvider, lastOpSeqNumber, firstAck, immediateSummary, raiseSummarizingError, summaryCollection) static
waitStop()

Properties

disposed

Signature:

get disposed(): boolean;

tryGetCorrelatedLogger

RunningSummarizer’s logger includes the sequenced index of the current summary on each event. If some other Summarizer code wants that event on their logs they can get it here, but only if they’re logging about that same summary.

Signature:

tryGetCorrelatedLogger: (summaryOpRefSeq: any) => ITelemetryLogger | undefined;

Methods

dispose

Signature:

dispose(): void;

Returns:

void

handleOp

Signature:

handleOp(error: any, op: ISequencedDocumentMessage): void;

Parameters

List of parameters
Parameter Type Description
error any
op ISequencedDocumentMessage

Returns:

void

handleSystemOp

Signature:

handleSystemOp(op: ISequencedDocumentMessage): void;

Parameters

List of parameters
Parameter Type Description
op ISequencedDocumentMessage

Returns:

void

start

Signature:

static start(clientId: string, onBehalfOfClientId: string, logger: ITelemetryLogger, summaryWatcher: IClientSummaryWatcher, configuration: ISummaryConfiguration, internalsProvider: Pick<ISummarizerInternalsProvider, "generateSummary">, lastOpSeqNumber: number, firstAck: ISummaryAttempt, immediateSummary: boolean, raiseSummarizingError: (description: string) => void, summaryCollection: SummaryCollection): Promise<RunningSummarizer>;

Parameters

List of parameters
Parameter Type Description
clientId string
onBehalfOfClientId string
logger ITelemetryLogger
summaryWatcher IClientSummaryWatcher
configuration ISummaryConfiguration
internalsProvider Pick<ISummarizerInternalsProvider, "generateSummary">
lastOpSeqNumber number
firstAck ISummaryAttempt
immediateSummary boolean
raiseSummarizingError (description: string) => void
summaryCollection SummaryCollection

Returns:

Promise<RunningSummarizer>

waitStop

Signature:

waitStop(): Promise<void>;

Returns:

Promise<void>