Interface HostedInstanceManager

Is responsible for running and handling separate Theia instance with given plugin.

interface HostedInstanceManager {
    debug(
        pluginUri: URI,
        debugConfig: PluginDebugConfiguration,
    ): Promise<URI>;
    getInstanceURI(): URI;
    getPluginURI(): URI;
    isPluginValid(uri: URI): Promise<boolean>;
    isRunning(): boolean;
    run(pluginUri: URI, port?: number): Promise<URI>;
    terminate(): void;
}

Implemented by

AbstractHostedInstanceManager

Index

Methods

debug getInstanceURI getPluginURI isPluginValid isRunning run terminate

Methods

debug

debug(pluginUri: URI, debugConfig: PluginDebugConfiguration): Promise<URI>
Runs specified by the given uri plugin with debug in separate Theia instance.
Parameters
- pluginUri: URI
  uri to the plugin source location
- debugConfig: PluginDebugConfiguration
  debug configuration
Returns Promise<URI>
uri where new Theia instance is run
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:63

getInstanceURI

getInstanceURI(): URI
Returns uri where hosted instance is run. Throws error if instance is not running.

Returns URI
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:75

getPluginURI

getPluginURI(): URI
Returns uri where plugin loaded into hosted instance is located. Throws error if instance is not running.

Returns URI
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:81

isPluginValid

isPluginValid(uri: URI): Promise<boolean>
Checks whether given uri points to a valid plugin.
Parameters
- uri: URI
  uri to the plugin source location
Returns Promise<boolean>
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:88

isRunning

isRunning(): boolean
Checks whether hosted instance is run.

Returns boolean
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:46

run

run(pluginUri: URI, port?: number): Promise<URI>
Runs specified by the given uri plugin in separate Theia instance.
Parameters
- pluginUri: URI
  uri to the plugin source location
- Optionalport: number
  port on which new instance of Theia should be run. Optional.
Returns Promise<URI>
uri where new Theia instance is run
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:55

terminate

terminate(): void
Terminates hosted plugin instance. Throws error if instance is not running.

Returns void
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:69