Class AbstractPluginHostRPC<PM, PAF, EXT>`Abstract`

Handle the RPC calls.

Type Parameters

PM extends AbstractPluginManagerExtImpl<any>
is the plugin manager (ext) type
PAF
is the plugin API factory type
EXT extends Partial<ExtInterfaces>
is the type identifying the Ext interfaces supported by the plugin manager

Hierarchy (view full)

AbstractPluginHostRPC
- PluginHostRPC

Index

Constructors

Properties

apiFactory backendInitPath banner extRpc loadContainerModule pluginManager rpc

Methods

createAPIFactory createExtInterfaces createPluginHost getBackendPluginPath initContext initExtApi initialize registerExtInterfaces terminate

Constructors

constructor

new AbstractPluginHostRPC<PM, PAF, EXT>(name, backendInitPath, extRpc): AbstractPluginHostRPC<PM, PAF, EXT>
Type Parameters
- PM extends AbstractPluginManagerExtImpl<any>
- PAF
- EXT extends Partial<ExtInterfaces>
Parameters
- name: string
- backendInitPath: undefined | string
- extRpc: RpcKeys<EXT>
Returns AbstractPluginHostRPC<PM, PAF, EXT>
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:101

Properties

`Protected` apiFactory

apiFactory: PAF

`Private` `Readonly` backendInitPath

backendInitPath: undefined | string

`Protected` `Readonly` banner

banner: string

`Private` `Readonly` extRpc

extRpc: RpcKeys<EXT>

`Protected` `Readonly` loadContainerModule

loadContainerModule: PluginContainerModuleLoader

`Protected` `Readonly` pluginManager

pluginManager: PM

`Protected` `Readonly` rpc

rpc: any

Methods

`Protected` `Abstract` createAPIFactory

createAPIFactory(extInterfaces): PAF
Parameters
- extInterfaces: EXT
Returns PAF
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:124

`Protected` `Abstract` createExtInterfaces

createExtInterfaces(): EXT
Returns EXT
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:126

createPluginHost

createPluginHost(): PluginHost
Create the PluginHost that is required by my plugin manager ext interface to delegate critical behaviour such as loading and initializing plugins to me.

Returns PluginHost
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:161

`Protected` getBackendPluginPath

getBackendPluginPath(pluginModel): undefined | string
Parameters
- pluginModel: PluginModel
Returns undefined | string
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:153

initContext

initContext(contextPath, plugin): void
Parameters
- contextPath: string
- plugin: Plugin
Returns void
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:141

`Protected` `Abstract` initExtApi

initExtApi(extApi): void
Initialize the end of the given provided extension API applicable to the current plugin host. Errors should be propagated to the caller.
Parameters
- extApi: ExtPluginApi
  the extension API to initialize, if appropriate
Returns void
Throws
if any error occurs in initializing the extension API
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:276

initialize

initialize(): void
Returns void
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:109

`Protected` registerExtInterfaces

registerExtInterfaces(extInterfaces): void
Parameters
- extInterfaces: EXT
Returns void
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:128

terminate

terminate(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:120