Sphinx Process Management

The language server provides additional notifications and commands that the client can use to provide greater insight and control over the Sphinx sub-processes mananged by esbonio

Life-Cycle Notifications

The following notifications will be emitted following during the life-cycle of a Sphinx sub-process

class esbonio.server.features.sphinx_manager.manager.ClientCreatedNotification(id, scope, config, pid)

The payload of a sphinx/clientCreated notification

config: SphinxConfig

The final configuration.

id: str

The client’s id

pid: int

The process id of the client process.

scope: str

The scope at which the client was created.

class esbonio.server.features.sphinx_manager.manager.AppCreatedNotification(id, application)

The payload of a sphinx/appCreated notification

application: SphinxInfo

Details about the created application.

id: str

The client’s id

class esbonio.server.features.sphinx_manager.manager.ClientErroredNotification(id, error, detail)

The payload of a sphinx/clientErrored notification

detail: str

Detailed description of the error.

error: str

Short description of the error.

id: str

The client’s id

class esbonio.server.features.sphinx_manager.manager.ClientDestroyedNotification(id)

The payload of sphinx/clientDestroyed notification.

id: str

The client’s id

Commands

The server offers the following commands for controlling the underlying Sphinx processes. They are invoked using an workspace/executeCommand request

esbonio.sphinx.restart

Restart the given Sphinx client(s). This command accepts a list of objects of the following form

{"id": "a0a5a856-d4ec-4c45-8461-78748ddbd06f"}

Where each id corresponds to a Sphinx Client.