Class NodeHostedPluginRunner

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

Hierarchy (View Summary)

AbstractHostedInstanceManager
- NodeHostedPluginRunner

Constructors

constructor

new NodeHostedPluginRunner(): NodeHostedPluginRunner
Returns NodeHostedPluginRunner
Inherited from AbstractHostedInstanceManager.constructor

Properties

`Protected`hostedInstanceProcess

hostedInstanceProcess: ChildProcess

`Protected` `Readonly`hostedPluginProcess

hostedPluginProcess: HostedPluginProcess

`Protected` `Readonly`hostedPluginSupport

hostedPluginSupport: HostedPluginSupport

`Protected`instanceOptions

instanceOptions: Omit<RequestOptions, "url">

`Protected`instanceUri

instanceUri: URI

`Protected`isPluginRunning

isPluginRunning: boolean = false

`Protected` `Readonly`metadata

metadata: MetadataScanner

`Protected`pluginUri

pluginUri: URI

`Protected` `Readonly`request

request: RequestService

`Protected` `Readonly`uriPostProcessors

uriPostProcessors: ContributionProvider<HostedPluginUriPostProcessor>

Methods

checkInstanceUriReady

checkInstanceUriReady(): Promise<void>
Checks that the instanceUri is responding before exiting method

Returns Promise<void>
Inherited from AbstractHostedInstanceManager.checkInstanceUriReady
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:189

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
Inherited from AbstractHostedInstanceManager.debug
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:126

getInstanceURI

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

Returns URI
Inherited from AbstractHostedInstanceManager.getInstanceURI
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:172

getPluginURI

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

Returns URI
Inherited from AbstractHostedInstanceManager.getPluginURI
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:179

`Protected`getStartCommand

getStartCommand(
port?: number,
debugConfig?: PluginDebugConfiguration,
): Promise<string[]>
Parameters
- Optionalport: number
- OptionaldebugConfig: PluginDebugConfiguration
Returns Promise<string[]>
Overrides AbstractHostedInstanceManager.getStartCommand
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:382

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>
Inherited from AbstractHostedInstanceManager.isPluginValid
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:228

`Protected`isPortFree

isPortFree(port: number): Promise<boolean>
Parameters
- port: number
Returns Promise<boolean>
Inherited from AbstractHostedInstanceManager.isPortFree
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:347

isRunning

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

Returns boolean
Inherited from AbstractHostedInstanceManager.isRunning
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:118

`Protected`postProcessInstanceOptions

postProcessInstanceOptions(options: object): Promise<object>
Parameters
- options: object
Returns Promise<object>
Overrides AbstractHostedInstanceManager.postProcessInstanceOptions
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:375

`Protected`postProcessInstanceUri

postProcessInstanceUri(uri: URI): Promise<URI>
Parameters
- uri: URI
Returns Promise<URI>
Overrides AbstractHostedInstanceManager.postProcessInstanceUri
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:368

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
Inherited from AbstractHostedInstanceManager.run
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:122

`Protected`runHostedPluginTheiaInstance

runHostedPluginTheiaInstance(
command: string[],
options: SpawnOptions,
): Promise<URI>
Parameters
- command: string[]
- options: SpawnOptions
Returns Promise<URI>
Inherited from AbstractHostedInstanceManager.runHostedPluginTheiaInstance
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:295

terminate

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

Returns void
Inherited from AbstractHostedInstanceManager.terminate
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:162

`Protected`validatePort

validatePort(port: number): Promise<void>
Parameters
- port: number
Returns Promise<void>
Inherited from AbstractHostedInstanceManager.validatePort
- Defined in plugin-dev/src/node/hosted-instance-manager.ts:337

Class NodeHostedPluginRunner

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NodeHostedPluginRunner

Properties

ProtectedhostedInstanceProcess

Protected ReadonlyhostedPluginProcess

Protected ReadonlyhostedPluginSupport

ProtectedinstanceOptions

ProtectedinstanceUri

ProtectedisPluginRunning

Protected Readonlymetadata

ProtectedpluginUri

Protected Readonlyrequest

Protected ReadonlyuriPostProcessors

Methods

checkInstanceUriReady

Returns Promise<void>

debug

Parameters

Returns Promise<URI>

getInstanceURI

Returns URI

getPluginURI

Returns URI

ProtectedgetStartCommand

Parameters

Returns Promise<string[]>

isPluginValid

Parameters

Returns Promise<boolean>

ProtectedisPortFree

Parameters

Returns Promise<boolean>

isRunning

Returns boolean

ProtectedpostProcessInstanceOptions

Parameters

Returns Promise<object>

ProtectedpostProcessInstanceUri

Parameters

Returns Promise<URI>

run

Parameters

Returns Promise<URI>

ProtectedrunHostedPluginTheiaInstance

Parameters

Returns Promise<URI>

terminate

Returns void

ProtectedvalidatePort

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`hostedInstanceProcess

`Protected` `Readonly`hostedPluginProcess

`Protected` `Readonly`hostedPluginSupport

`Protected`instanceOptions

`Protected`instanceUri

`Protected`isPluginRunning

`Protected` `Readonly`metadata

`Protected`pluginUri

`Protected` `Readonly`request

`Protected` `Readonly`uriPostProcessors

`Protected`getStartCommand

`Protected`isPortFree

`Protected`postProcessInstanceOptions

`Protected`postProcessInstanceUri

`Protected`runHostedPluginTheiaInstance

`Protected`validatePort