Class Controller

Hierarchy

Controller

Constructors

constructor

new Controller(options: ControllerOptions): Controller
Parameters
- options: ControllerOptions
Returns Controller
- Defined in framework/src/controller/controller.ts:81

Properties

`Private` `Readonly` _appConfig

_appConfig: ApplicationConfigForPlugin

`Private` `Readonly` _bus

_bus: Bus

`Private` `Readonly` _chainID

_chainID: Buffer

`Private` `Optional` _channel

_channel?: InMemoryChannel

`Private` `Readonly` _childProcesses

_childProcesses: Record<string, ChildProcess>

`Private` `Readonly` _config

_config: ControllerConfig

`Private` `Readonly` _endpointHandlers

_endpointHandlers: {
[namespace: string]: EndpointHandlers;
}

Type declaration

[namespace: string]: EndpointHandlers

`Private` `Readonly` _inMemoryPlugins

_inMemoryPlugins: Record<string, {
channel: BaseChannel;
plugin: BasePlugin<Record<string, unknown>>;
}>

`Private` `Readonly` _internalIPCServer

_internalIPCServer: IPCServer

`Private` _logger

_logger: Logger

`Private` _moduleDB

_moduleDB: Database

`Private` `Readonly` _pluginConfigs

_pluginConfigs: Record<string, PluginConfig>

`Private` `Readonly` _plugins

_plugins: {
[key: string]: BasePlugin;
}

Type declaration

[key: string]: BasePlugin

`Private` _stateDB

_stateDB: StateDB

Accessors

channel

get channel(): InMemoryChannel
Returns InMemoryChannel
- Defined in framework/src/controller/controller.ts:107

Methods

`Private` _loadChildProcessPlugin

_loadChildProcessPlugin(plugin: BasePlugin<Record<string, unknown>>, config: PluginConfig, appConfig: ApplicationConfigForPlugin): Promise<void>
Parameters
- plugin: BasePlugin<Record<string, unknown>>
- config: PluginConfig
- appConfig: ApplicationConfigForPlugin
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:280

`Private` _loadInMemoryPlugin

_loadInMemoryPlugin(plugin: BasePlugin<Record<string, unknown>>, config: PluginConfig, appConfig: ApplicationConfigForPlugin): Promise<void>
Parameters
- plugin: BasePlugin<Record<string, unknown>>
- config: PluginConfig
- appConfig: ApplicationConfigForPlugin
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:252

`Private` _unloadChildProcessPlugin

_unloadChildProcessPlugin(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:353

`Private` _unloadInMemoryPlugin

_unloadInMemoryPlugin(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:341

`Private` _unloadPlugins

_unloadPlugins(): Promise<void>
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:221

getEndpoints

getEndpoints(): readonly string[]
Returns readonly string[]
- Defined in framework/src/controller/controller.ts:114

getEvents

getEvents(): readonly string[]
Returns readonly string[]
- Defined in framework/src/controller/controller.ts:118

getRegisteredPlugins

getRegisteredPlugins(): {
[key: string]: BasePlugin;
}
Returns {
[key: string]: BasePlugin;
}
- [key: string]: BasePlugin
- Defined in framework/src/controller/controller.ts:160

init

init(arg: ControllerInitArg): void
Parameters
- arg: ControllerInitArg
Returns void
- Defined in framework/src/controller/controller.ts:122

registerEndpoint

registerEndpoint(namespace: string, handlers: EndpointHandlers): void
Parameters
- namespace: string
- handlers: EndpointHandlers
Returns void
- Defined in framework/src/controller/controller.ts:164

registerPlugin

registerPlugin(plugin: BasePlugin<Record<string, unknown>>, options: PluginConfig): void
Parameters
- plugin: BasePlugin<Record<string, unknown>>
- options: PluginConfig
Returns void
- Defined in framework/src/controller/controller.ts:138

start

start(): Promise<void>
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:171

stop

stop(_code?: number, reason?: string): Promise<void>
Parameters
- Optional _code: number
- Optional reason: string
Returns Promise<void>
- Defined in framework/src/controller/controller.ts:199

Class Controller

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ControllerOptions

Returns Controller

Properties

Private Readonly _appConfig

Private Readonly _bus

Private Readonly _chainID

Private Optional _channel

Private Readonly _childProcesses

Private Readonly _config

Private Readonly _endpointHandlers

Type declaration

[namespace: string]: EndpointHandlers

Private Readonly _inMemoryPlugins

Private Readonly _internalIPCServer

Private _logger

Private _moduleDB

Private Readonly _pluginConfigs

Private Readonly _plugins

Type declaration

[key: string]: BasePlugin

Private _stateDB

Accessors

channel

Returns InMemoryChannel

Methods

Private _loadChildProcessPlugin

Parameters

plugin: BasePlugin<Record<string, unknown>>

config: PluginConfig

appConfig: ApplicationConfigForPlugin

Returns Promise<void>

Private _loadInMemoryPlugin

Parameters

plugin: BasePlugin<Record<string, unknown>>

config: PluginConfig

appConfig: ApplicationConfigForPlugin

Returns Promise<void>

Private _unloadChildProcessPlugin

Parameters

name: string

Returns Promise<void>

Private _unloadInMemoryPlugin

Parameters

name: string

Returns Promise<void>

Private _unloadPlugins

Returns Promise<void>

getEndpoints

Returns readonly string[]

getEvents

Returns readonly string[]

getRegisteredPlugins

Returns { [key: string]: BasePlugin; }

[key: string]: BasePlugin

init

Parameters

arg: ControllerInitArg

Returns void

registerEndpoint

Parameters

namespace: string

handlers: EndpointHandlers

Returns void

registerPlugin

Parameters

plugin: BasePlugin<Record<string, unknown>>

options: PluginConfig

Returns void

start

Returns Promise<void>

`Private` `Readonly` _appConfig

`Private` `Readonly` _bus

`Private` `Readonly` _chainID

`Private` `Optional` _channel

`Private` `Readonly` _childProcesses

`Private` `Readonly` _config

`Private` `Readonly` _endpointHandlers

`Private` `Readonly` _inMemoryPlugins

`Private` `Readonly` _internalIPCServer

`Private` _logger

`Private` _moduleDB

`Private` `Readonly` _pluginConfigs

`Private` `Readonly` _plugins

`Private` _stateDB

`Private` _loadChildProcessPlugin

`Private` _loadInMemoryPlugin

`Private` _unloadChildProcessPlugin

`Private` _unloadInMemoryPlugin

`Private` _unloadPlugins

Returns {
[key: string]: BasePlugin;
}

`Optional` _code: number

`Optional` reason: string