Interface ILSPDocumentConnectionManager`Alpha`

The LSP connection state manager

interface ILSPDocumentConnectionManager {
    adapters: Map<
        string,
        WidgetLSPAdapter<IDocumentWidget<Widget, DocumentRegistry.IModel>>,
    >;
    closed: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>;
    connected: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>;
    connections: Map<string, ILSPConnection>;
    disconnected: ISignal<
        ILSPDocumentConnectionManager,
        IDocumentConnectionData,
    >;
    documents: Map<string, VirtualDocument>;
    documentsChanged: ISignal<
        ILSPDocumentConnectionManager,
        Map<string, VirtualDocument>,
    >;
    initialConfigurations: Partial<Record<TLanguageServerId, LanguageServer1>>;
    initialized: ISignal<
        ILSPDocumentConnectionManager,
        IDocumentConnectionData,
    >;
    languageServerManager: ILanguageServerManager;
    ready: Promise<void>;
    connect(
        options: ISocketConnectionOptions,
        firstTimeoutSeconds?: number,
        secondTimeoutMinute?: number,
    ): Promise<undefined | ILSPConnection>;
    disconnect(languageId: TLanguageServerId): void;
    registerAdapter(
        path: string,
        adapter: WidgetLSPAdapter<
            IDocumentWidget<Widget, DocumentRegistry.IModel>,
        >,
    ): void;
    retryToConnect(
        options: ISocketConnectionOptions,
        reconnectDelay: number,
        retrialsLeft: number,
    ): Promise<void>;
    unregisterDocument(uri: string): void;
    updateConfiguration(
        allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>,
    ): void;
    updateLogging(logAllCommunication: boolean, setTrace: TraceValues): void;
    updateServerConfigurations(
        allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>,
    ): void;
}

Implemented by

DocumentConnectionManager

Index

Properties

adapters closed connected connections disconnected documents documentsChanged initialConfigurations initialized languageServerManager ready

Methods

connect disconnect registerAdapter retryToConnect unregisterDocument updateConfiguration updateLogging updateServerConfigurations

Properties

`Alpha`adapters

adapters: Map<
string,
WidgetLSPAdapter<IDocumentWidget<Widget, DocumentRegistry.IModel>>,
>

Deprecated

The mapping of document uri to the widget adapter.

`Alpha`closed

closed: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>

Signal emitted when a virtual document is closed.

`Alpha`connected

connected: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>

Signal emitted when a connection is connected.

`Alpha`connections

connections: Map<string, ILSPConnection>

The mapping of document uri to the connection to language server.

`Alpha`disconnected

disconnected: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>

Signal emitted when a connection is disconnected.

`Alpha`documents

documents: Map<string, VirtualDocument>

The mapping of document uri to the virtual document.

`Alpha`documentsChanged

documentsChanged: ISignal<
ILSPDocumentConnectionManager,
Map<string, VirtualDocument>,
>

Signal emitted when the content of a virtual document is changed.

`Alpha`initialConfigurations

initialConfigurations: Partial<Record<TLanguageServerId, LanguageServer1>>

Initial configuration for the language servers.

`Alpha`initialized

initialized: ISignal<ILSPDocumentConnectionManager, IDocumentConnectionData>

Signal emitted when the language server is initialized.

`Alpha`languageServerManager

languageServerManager: ILanguageServerManager

The language server manager instance.

`Readonly` `Alpha`ready

ready: Promise<void>

A promise that is fulfilled when the connection manager is ready.

Methods

connect

connect(
    options: ISocketConnectionOptions,
    firstTimeoutSeconds?: number,
    secondTimeoutMinute?: number,
): Promise<undefined | ILSPConnection>
Alpha
Create a new connection to the language server
Parameters
- options: ISocketConnectionOptions
- OptionalfirstTimeoutSeconds: number
- OptionalsecondTimeoutMinute: number
Returns Promise<undefined | ILSPConnection>
A promise of the LSP connection
- Defined in packages/lsp/src/tokens.ts:458

disconnect

disconnect(languageId: TLanguageServerId): void
Alpha
Disconnect the connection to the language server of the requested language.
Parameters
- languageId: TLanguageServerId
Returns void
- Defined in packages/lsp/src/tokens.ts:468

registerAdapter

registerAdapter(
path: string,
adapter: WidgetLSPAdapter<IDocumentWidget<Widget, DocumentRegistry.IModel>>,
): void
Alpha
Parameters
- path: string
  path to current document widget of input adapter
- adapter: WidgetLSPAdapter<IDocumentWidget<Widget, DocumentRegistry.IModel>>
  the adapter need to be registered
Returns void
Deprecated
Register a widget adapter.
- Defined in packages/lsp/src/tokens.ts:483

retryToConnect

retryToConnect(
    options: ISocketConnectionOptions,
    reconnectDelay: number,
    retrialsLeft: number,
): Promise<void>
Alpha
Retry to connect to the server each reconnectDelay seconds and for retrialsLeft times.
Parameters
- options: ISocketConnectionOptions
- reconnectDelay: number
- retrialsLeft: number
Returns Promise<void>
- Defined in packages/lsp/src/tokens.ts:448

unregisterDocument

unregisterDocument(uri: string): void
Alpha
Disconnect the signals of requested virtual document uri.
Parameters
- uri: string
Returns void
- Defined in packages/lsp/src/tokens.ts:473

updateConfiguration

updateConfiguration(
allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>,
): void
Alpha
Handles the settings that do not require an existing connection with a language server (or can influence to which server the connection will be created, e.g. rank).

This function should be called before initialization of servers.
Parameters
- allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>
Returns void
- Defined in packages/lsp/src/tokens.ts:425

updateLogging

updateLogging(logAllCommunication: boolean, setTrace: TraceValues): void
Alpha
Enable or disable the logging of language server communication.
Parameters
- logAllCommunication: boolean
- setTrace: TraceValues
Returns void
- Defined in packages/lsp/src/tokens.ts:430

updateServerConfigurations

updateServerConfigurations(
allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>,
): void
Alpha
Handles the settings that the language servers accept using onDidChangeConfiguration messages, which should be passed under the "serverSettings" keyword in the setting registry. Other configuration options are handled by updateConfiguration instead.

This function should be called after initialization of servers.
Parameters
- allServerSettings: Partial<Record<TLanguageServerId, LanguageServer1>>
Returns void
- Defined in packages/lsp/src/tokens.ts:440

Interface ILSPDocumentConnectionManagerAlpha

Implemented by

Index

Properties

Methods

Properties

Alphaadapters

Deprecated

Alphaclosed

Alphaconnected

Alphaconnections

Alphadisconnected

Alphadocuments

AlphadocumentsChanged

AlphainitialConfigurations

Alphainitialized

AlphalanguageServerManager

Readonly Alphaready

Methods

connect

Parameters

Returns Promise<undefined | ILSPConnection>

disconnect

Parameters

Returns void

registerAdapter

Parameters

Returns void

Deprecated

retryToConnect

Parameters

Returns Promise<void>

unregisterDocument

Parameters

Returns void

updateConfiguration

Parameters

Returns void

updateLogging

Parameters

Returns void

updateServerConfigurations

Parameters

Returns void

Settings

On This Page

Interface ILSPDocumentConnectionManager`Alpha`

`Alpha`adapters

`Alpha`closed

`Alpha`connected

`Alpha`connections

`Alpha`disconnected

`Alpha`documents

`Alpha`documentsChanged

`Alpha`initialConfigurations

`Alpha`initialized

`Alpha`languageServerManager

`Readonly` `Alpha`ready