driver-base.api.md

API Report File for "@fluidframework/driver-base"

Do not edit this file. It is a report generated by API Extractor.

import { ConnectionMode } from '@fluidframework/protocol-definitions';
import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
import { IAnyDriverError } from '@fluidframework/driver-definitions';
import { IClientConfiguration } from '@fluidframework/protocol-definitions';
import { IConnect } from '@fluidframework/protocol-definitions';
import { IConnected } from '@fluidframework/protocol-definitions';
import { IDisposable } from '@fluidframework/common-definitions';
import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISignalClient } from '@fluidframework/protocol-definitions';
import { ISignalMessage } from '@fluidframework/protocol-definitions';
import { ITelemetryLogger } from '@fluidframework/common-definitions';
import { ITokenClaims } from '@fluidframework/protocol-definitions';
import type { Socket } from 'socket.io-client';

// @public
export class DocumentDeltaConnection extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
    protected constructor(socket: Socket, documentId: string, logger: ITelemetryLogger, enableLongPollingDowngrades?: boolean);
    // (undocumented)
    protected addTrackedListener(event: string, listener: (...args: any[]) => void): void;
    checkpointSequenceNumber: number | undefined;
    get claims(): ITokenClaims;
    get clientId(): string;
    // (undocumented)
    protected closeSocketCore(error: IAnyDriverError): void;
    protected createErrorObject(handler: string, error?: any, canRetry?: boolean): IAnyDriverError;
    // (undocumented)
    get details(): IConnected;
    // (undocumented)
    protected disconnect(err: IAnyDriverError): void;
    protected disconnectCore(): void;
    dispose(): void;
    // (undocumented)
    get disposed(): boolean;
    protected _disposed: boolean;
    // (undocumented)
    documentId: string;
    // (undocumented)
    protected earlyOpHandler: (documentId: string, msgs: ISequencedDocumentMessage[]) => void;
    // (undocumented)
    protected earlySignalHandler: (msg: ISignalMessage) => void;
    // (undocumented)
    protected emitMessages(type: string, messages: IDocumentMessage[][]): void;
    // (undocumented)
    static readonly eventsAlwaysForwarded: string[];
    // (undocumented)
    static readonly eventsToForward: string[];
    get existing(): boolean;
    // (undocumented)
    protected get hasDetails(): boolean;
    get initialClients(): ISignalClient[];
    // (undocumented)
    protected initialize(connectMessage: IConnect, timeout: number): Promise<void>;
    get initialMessages(): ISequencedDocumentMessage[];
    get initialSignals(): ISignalMessage[];
    // @deprecated (undocumented)
    protected get logger(): ITelemetryLogger;
    get maxMessageSize(): number;
    get mode(): ConnectionMode;
    // (undocumented)
    protected readonly queuedMessages: ISequencedDocumentMessage[];
    // (undocumented)
    protected readonly queuedSignals: ISignalMessage[];
    get serviceConfiguration(): IClientConfiguration;
    // (undocumented)
    protected readonly socket: Socket;
    submit(messages: IDocumentMessage[]): void;
    // (undocumented)
    protected submitCore(type: string, messages: IDocumentMessage[]): void;
    submitSignal(message: IDocumentMessage): void;
    get version(): string;
}

// (No @packageDocumentation comment for this package)