Class HeadlessHostedPluginSupport

Hierarchy (View Summary)

AbstractHostedPluginSupport<HeadlessPluginManagerExt, HostedPluginServer>
- HeadlessHostedPluginSupport

Constructors

constructor

new HeadlessHostedPluginSupport(): HeadlessHostedPluginSupport
Returns HeadlessHostedPluginSupport
Overrides AbstractHostedPluginSupport.constructor
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:68

Properties

`Protected` `Readonly`activationEvents

activationEvents: Set<string>

`Protected` `Readonly`clientId

clientId: string

`Protected`container

container: Container

`Protected` `Readonly`contributions

contributions: Map<`${string}.${string}`, PluginContributions>

`Protected` `Readonly`deferredDidStart

deferredDidStart: Deferred<void>

`Protected` `Readonly`deferredWillStart

deferredWillStart: Deferred<void>

`Protected` `Readonly`envServer

envServer: EnvVariablesServer

load

load: DebouncedFuncLeading<() => Promise<void>>

`Protected`loadQueue

loadQueue: Promise<void>

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`mainPluginApiProviders

mainPluginApiProviders: ContributionProvider<MainPluginApiProvider>

`Protected` `Readonly`managers

managers: Map<string, HeadlessPluginManagerExt>

`Readonly`onDidChangePlugins

onDidChangePlugins: Event<void>

`Protected` `Readonly`onDidChangePluginsEmitter

onDidChangePluginsEmitter: Emitter<void>

`Protected` `Readonly`pluginDeployer

pluginDeployer: PluginDeployerImpl

`Protected` `Readonly`pluginPathsService

pluginPathsService: PluginPathsService

`Protected` `Readonly`pluginProcess

pluginProcess: HostedPluginProcess

`Protected` `Readonly`pluginServer

pluginServer: PluginServer

`Protected` `Readonly`scanner

scanner: TheiaHeadlessPluginScanner

`Protected` `Readonly`server

server: HostedPluginServer

`Protected` `Readonly`shellTerminalServer

shellTerminalServer: IShellTerminalServer

`Protected` `Readonly`stopwatch

stopwatch: Stopwatch

`Protected` `Readonly`supportedActivationEventsContributions

supportedActivationEventsContributions: ContributionProvider<string[]>

`Protected`theiaReadyPromise

theiaReadyPromise: Promise<unknown>

Accessors

didStart

get didStart(): Promise<void>
Resolves when the initial plugins are started.

Returns Promise<void>
Inherited from AbstractHostedPluginSupport.didStart
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:39

plugins

get plugins(): PluginMetadata[]
Returns PluginMetadata[]
Inherited from AbstractHostedPluginSupport.plugins
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:43

willStart

get willStart(): Promise<void>
Resolves when the initial plugins are loaded and about to be started.

Returns Promise<void>
Inherited from AbstractHostedPluginSupport.willStart
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:34

Methods

`Protected`acceptPlugin

acceptPlugin(plugin: DeployedPlugin): boolean | DeployedPlugin
Only load headless plugins
Parameters
- plugin: DeployedPlugin
Returns boolean | DeployedPlugin
Overrides AbstractHostedPluginSupport.acceptPlugin
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:81

activateByEvent

activateByEvent(activationEvent: string): Promise<void>
Parameters
- activationEvent: string
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.activateByEvent
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:77

activatePlugin

activatePlugin(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.activatePlugin
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:78

`Protected`afterLoadContributions

afterLoadContributions(toDisconnect: DisposableCollection): Promise<void>
Parameters
- toDisconnect: DisposableCollection
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.afterLoadContributions
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:54

`Protected`afterStart

afterStart(): void
Returns void
Inherited from AbstractHostedPluginSupport.afterStart
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:47

`Protected`beforeLoadContributions

beforeLoadContributions(toDisconnect: DisposableCollection): Promise<void>
Parameters
- toDisconnect: DisposableCollection
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.beforeLoadContributions
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:53

`Protected`beforeSyncPlugins

beforeSyncPlugins(toDisconnect: DisposableCollection): Promise<void>
Parameters
- toDisconnect: DisposableCollection
Returns Promise<void>
Overrides AbstractHostedPluginSupport.beforeSyncPlugins
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:100

`Protected`createServerRpc

createServerRpc(pluginHostId: string): RPCProtocol
Parameters
- pluginHostId: string
Returns RPCProtocol
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:159

`Protected`createTheiaReadyPromise

createTheiaReadyPromise(): Promise<unknown>
Returns Promise<unknown>
Overrides AbstractHostedPluginSupport.createTheiaReadyPromise
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:76

`Protected`doLoad

doLoad(): Promise<void>
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.doLoad
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:51

`Protected`getHostGlobalStoragePath

getHostGlobalStoragePath(): Promise<string>
Returns Promise<string>
Overrides AbstractHostedPluginSupport.getHostGlobalStoragePath
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:171

getPlugin

getPlugin(id: `${string}.${string}`): undefined | DeployedPlugin
Parameters
- id: `${string}.${string}`
Returns undefined | DeployedPlugin
Inherited from AbstractHostedPluginSupport.getPlugin
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:44

`Protected`getPluginCount

getPluginCount(plugins: number): string
Parameters
- plugins: number
Returns string
Inherited from AbstractHostedPluginSupport.getPluginCount
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:81

`Protected`getStoragePath

getStoragePath(): Promise<undefined | string>
Returns Promise<undefined | string>
Overrides AbstractHostedPluginSupport.getStoragePath
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:165

`Protected`handleContributions

handleContributions(_plugin: DeployedPlugin): Disposable
Parameters
- _plugin: DeployedPlugin
Returns Disposable
Overrides AbstractHostedPluginSupport.handleContributions
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:95

`Protected`handlePluginStarted

handlePluginStarted(
manager: HeadlessPluginManagerExt,
plugin: DeployedPlugin,
): void
Parameters
- manager: HeadlessPluginManagerExt
- plugin: DeployedPlugin
Returns void
Inherited from AbstractHostedPluginSupport.handlePluginStarted
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:79

`Protected`init

init(): void
Returns void
Inherited from AbstractHostedPluginSupport.init
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:41

`Protected`initRpc

initRpc(host: string, pluginId: string): RPCProtocol
Parameters
- host: string
- pluginId: string
Returns RPCProtocol
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:151

`Protected`loadContributions

loadContributions(
toDisconnect: DisposableCollection,
): Map<string, PluginContributions[]>
Always synchronous in order to simplify handling disconnections.
Parameters
- toDisconnect: DisposableCollection
Returns Map<string, PluginContributions[]>
Throws
never
Inherited from AbstractHostedPluginSupport.loadContributions
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:71

`Protected`measure

measure(name: string): Measurement
Parameters
- name: string
Returns Measurement
Inherited from AbstractHostedPluginSupport.measure
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:80

`Protected`obtainManager

obtainManager(
    host: string,
    hostContributions: PluginContributions[],
    toDisconnect: DisposableCollection,
): Promise<undefined | HeadlessPluginManagerExt>
Parameters
- host: string
- hostContributions: PluginContributions[]
- toDisconnect: DisposableCollection
Returns Promise<undefined | HeadlessPluginManagerExt>
Overrides AbstractHostedPluginSupport.obtainManager
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:110

onStart

onStart(container: Container): void
do not call it, except from the plugin frontend contribution
Parameters
- container: Container
Returns void
Inherited from AbstractHostedPluginSupport.onStart
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:46

`Protected`runOperation

runOperation(operation: () => Promise<void>): Promise<void>
Parameters
- operation: () => Promise<void>
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.runOperation
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:50

shutDown

shutDown(): void
Returns void
- Defined in plugin-ext-headless/src/hosted/node/headless-hosted-plugin.ts:72

`Protected`startPlugins

startPlugins(
contributionsByHost: Map<string, PluginContributions[]>,
toDisconnect: DisposableCollection,
): Promise<void>
Parameters
- contributionsByHost: Map<string, PluginContributions[]>
- toDisconnect: DisposableCollection
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.startPlugins
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:73

`Protected`syncPlugins

syncPlugins(): Promise<void>
Sync loaded and deployed plugins:
- undeployed plugins are unloaded
- newly deployed plugins are initialized
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.syncPlugins
- Defined in plugin-ext/lib/hosted/common/hosted-plugin.d.ts:60

Class HeadlessHostedPluginSupport

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HeadlessHostedPluginSupport

Properties

Protected ReadonlyactivationEvents

Protected ReadonlyclientId

Protectedcontainer

Protected Readonlycontributions

Protected ReadonlydeferredDidStart

Protected ReadonlydeferredWillStart

Protected ReadonlyenvServer

load

ProtectedloadQueue

Protected Readonlylogger

Protected ReadonlymainPluginApiProviders

Protected Readonlymanagers

ReadonlyonDidChangePlugins

Protected ReadonlyonDidChangePluginsEmitter

Protected ReadonlypluginDeployer

Protected ReadonlypluginPathsService

Protected ReadonlypluginProcess

Protected ReadonlypluginServer

Protected Readonlyscanner

Protected Readonlyserver

Protected ReadonlyshellTerminalServer

Protected Readonlystopwatch

Protected ReadonlysupportedActivationEventsContributions

ProtectedtheiaReadyPromise

Accessors

didStart

Returns Promise<void>

plugins

Returns PluginMetadata[]

willStart

Returns Promise<void>

Methods

ProtectedacceptPlugin

Parameters

Returns boolean | DeployedPlugin

activateByEvent

Parameters

Returns Promise<void>

activatePlugin

Parameters

Returns Promise<void>

ProtectedafterLoadContributions

Parameters

Returns Promise<void>

ProtectedafterStart

Returns void

ProtectedbeforeLoadContributions

Parameters

Returns Promise<void>

ProtectedbeforeSyncPlugins

Parameters

Returns Promise<void>

ProtectedcreateServerRpc

Parameters

Returns RPCProtocol

ProtectedcreateTheiaReadyPromise

Returns Promise<unknown>

ProtecteddoLoad

Returns Promise<void>

ProtectedgetHostGlobalStoragePath

Returns Promise<string>

getPlugin

Parameters

Returns undefined | DeployedPlugin

ProtectedgetPluginCount

Parameters

Returns string

ProtectedgetStoragePath

Returns Promise<undefined | string>

`Protected` `Readonly`activationEvents

`Protected` `Readonly`clientId

`Protected`container

`Protected` `Readonly`contributions

`Protected` `Readonly`deferredDidStart

`Protected` `Readonly`deferredWillStart

`Protected` `Readonly`envServer

`Protected`loadQueue

`Protected` `Readonly`logger

`Protected` `Readonly`mainPluginApiProviders

`Protected` `Readonly`managers

`Readonly`onDidChangePlugins

`Protected` `Readonly`onDidChangePluginsEmitter

`Protected` `Readonly`pluginDeployer

`Protected` `Readonly`pluginPathsService

`Protected` `Readonly`pluginProcess

`Protected` `Readonly`pluginServer

`Protected` `Readonly`scanner

`Protected` `Readonly`server

`Protected` `Readonly`shellTerminalServer

`Protected` `Readonly`stopwatch

`Protected` `Readonly`supportedActivationEventsContributions

`Protected`theiaReadyPromise

`Protected`acceptPlugin

`Protected`afterLoadContributions

`Protected`afterStart

`Protected`beforeLoadContributions

`Protected`beforeSyncPlugins

`Protected`createServerRpc

`Protected`createTheiaReadyPromise

`Protected`doLoad

`Protected`getHostGlobalStoragePath

`Protected`getPluginCount

`Protected`getStoragePath

`Protected`handleContributions

`Protected`handlePluginStarted

`Protected`init

`Protected`initRpc

`Protected`loadContributions

`Protected`measure

`Protected`obtainManager

`Protected`runOperation

`Protected`startPlugins

`Protected`syncPlugins