Class AbstractHostedInstanceManager`Abstract`

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

Hierarchy (view full)

AbstractHostedInstanceManager
- NodeHostedPluginRunner
- ElectronNodeHostedPluginRunner

Implements

HostedInstanceManager

Constructors

constructor

new AbstractHostedInstanceManager(): AbstractHostedInstanceManager
Returns AbstractHostedInstanceManager

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

Methods

checkInstanceUriReady

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

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

debug

debug(pluginUri, debugConfig): 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
Implementation of HostedInstanceManager.debug
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:126

`Private` doRun

doRun(pluginUri, port?, debugConfig?): Promise<URI>
Parameters
- pluginUri: URI
- Optional port: number
- Optional debugConfig: PluginDebugConfiguration
Returns Promise<URI>
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:130

getInstanceURI

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

Returns URI
Implementation of HostedInstanceManager.getInstanceURI
- Defined in packages/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
Implementation of HostedInstanceManager.getPluginURI
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:179

`Protected` getStartCommand

getStartCommand(port?, debugConfig?): Promise<string[]>
Parameters
- Optional port: number
- Optional debugConfig: PluginDebugConfiguration
Returns Promise<string[]>
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:242

isPluginValid

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

`Protected` isPortFree

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

isRunning

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

Returns boolean
Implementation of HostedInstanceManager.isRunning
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:118

`Private` ping

ping(): Promise<boolean>
Ping the plugin URI (checking status of the head)

Returns Promise<boolean>
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:217

`Private` pingLoop

pingLoop(remainingCount, resolve, reject): Promise<void>
Start a loop to ping, if ping is OK return immediately, else start a new ping after 1second. We iterate for the given amount of loops provided in remainingCount
Parameters
- remainingCount: number
  the number of occurrence to check
- resolve: ((value?) => void)
  resolve function if ok
  - - (value?): void
    - Parameters
      Optional value: void | Error | PromiseLike<void>
      Returns void
- reject: ((value?) => void)
  reject function if error
  - - (value?): void
    - Parameters
      Optional value: void | Error | PromiseLike<void>
      Returns void
Returns Promise<void>
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:199

`Protected` postProcessInstanceOptions

postProcessInstanceOptions(options): Promise<Omit<RequestOptions, "url">>
Parameters
- options: Omit<RequestOptions, "url">
Returns Promise<Omit<RequestOptions, "url">>
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:291

`Protected` postProcessInstanceUri

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

run

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

`Protected` runHostedPluginTheiaInstance

runHostedPluginTheiaInstance(command, options): Promise<URI>
Parameters
- command: string[]
- options: SpawnOptions
Returns Promise<URI>
- Defined in packages/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
Implementation of HostedInstanceManager.terminate
- Defined in packages/plugin-dev/src/node/hosted-instance-manager.ts:162

`Protected` validatePort

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

Class AbstractHostedInstanceManagerAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AbstractHostedInstanceManager

Properties

Protected hostedInstanceProcess

Protected Readonly hostedPluginProcess

Protected Readonly hostedPluginSupport

Protected instanceOptions

Protected instanceUri

Protected isPluginRunning

Protected Readonly metadata

Protected pluginUri

Protected Readonly request

Methods

checkInstanceUriReady

Returns Promise<void>

debug

Parameters

Returns Promise<URI>

Private doRun

Parameters

Returns Promise<URI>

getInstanceURI

Returns URI

getPluginURI

Returns URI

Protected getStartCommand

Parameters

Returns Promise<string[]>

isPluginValid

Parameters

Returns Promise<boolean>

Protected isPortFree

Parameters

Returns Promise<boolean>

isRunning

Returns boolean

Private ping

Returns Promise<boolean>

Private pingLoop

Parameters

Parameters

Returns void

Parameters

Returns void

Returns Promise<void>

Protected postProcessInstanceOptions

Parameters

Returns Promise<Omit<RequestOptions, "url">>

Protected postProcessInstanceUri

Parameters

Returns Promise<URI>

run

Parameters

Returns Promise<URI>

Protected runHostedPluginTheiaInstance

Parameters

Returns Promise<URI>

terminate

Returns void

Protected validatePort

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Class AbstractHostedInstanceManager`Abstract`

`Protected` hostedInstanceProcess

`Protected` `Readonly` hostedPluginProcess

`Protected` `Readonly` hostedPluginSupport

`Protected` instanceOptions

`Protected` instanceUri

`Protected` isPluginRunning

`Protected` `Readonly` metadata

`Protected` pluginUri

`Protected` `Readonly` request

`Private` doRun

`Protected` getStartCommand

`Protected` isPortFree

`Private` ping

`Private` pingLoop

`Protected` postProcessInstanceOptions

`Protected` postProcessInstanceUri

`Protected` runHostedPluginTheiaInstance

`Protected` validatePort