Class Engine

Hierarchy

EngineProcessAPI
Hierarchy
- Engine

Index

Constructors

constructor

Accessors

numStreams

Constructors

constructor

new Engine(engineConfig?: Partial<EngineConfig>, engineExtraConfig?: Partial<EngineExtraConfig>): Engine
Parameters
- engineConfig: Partial<EngineConfig> = {}
- engineExtraConfig: Partial<EngineExtraConfig> = {}
  
  isLocal is defaulted to true
Returns Engine
Overrides EngineProcessAPI.constructor
- Defined in src/engine/engine.ts:149

Properties

`Private` #abortController

#abortController: AbortController = ...

`Private` #benthosEXEFullPath

#benthosEXEFullPath: string = "/tmp"

`Private` #constructorDone

#constructorDone: Deferred = ...

`Private` #debug

#debug: Debugger = ...

debug is used heavily; exthos:engine:debugLog - give general debug logs exthos:eventLog - print events as they are emitted exthos:engine:traceLog - prints trace information showing flow of code

`Private` #debugLog

#debugLog: Debugger = ...

`Private` #engineConfig

#engineConfig: EngineConfig

`Private` `Readonly` #engineConfigFilePath

#engineConfigFilePath: string = ...

`Private` #engineConstrStartStopMutex

#engineConstrStartStopMutex: Mutex = ...

`Private` #engineExtraConfig

#engineExtraConfig: EngineExtraConfig

`Private` #engineProcess

#engineProcess: ExecaChildProcess<string>

`Private` #engineStreamAddUpdateRemoveMutex

#engineStreamAddUpdateRemoveMutex: Mutex = ...

`Private` #engineUpdateConfigOptionsMutex

#engineUpdateConfigOptionsMutex: Mutex = ...

`Private` #eventLog

#eventLog: Debugger = ...

`Private` #eventNameToEventLog

#eventNameToEventLog: Partial<Record<engineEventsTypes, Debugger>> = {}

`Private` #isActive

#isActive: boolean = false

`Private` #keepAliveInterval

#keepAliveInterval: Timeout

`Private` #mgmtEventsFreqMs

#mgmtEventsFreqMs: number = 2000

`Private` #scheme

#scheme: "http" | "https" = "http"

`Private` #streamsMap

#streamsMap: { [key: string]: Stream } = {}

Type declaration

[key: string]: Stream

`Private` #tempLocalServer

#tempLocalServer: Server

`Private` #traceLog

#traceLog: Debugger = ...

`Protected` _axiosInstance

_axiosInstance: AxiosInstance

emit

emit: ((event: engineEventsTypes, eventObj: EventObj, ...values: any[]) => boolean) = ...

Type declaration

- (event: engineEventsTypes, eventObj: EventObj, ...values: any[]): boolean
- Parameters
  - event: engineEventsTypes
  - eventObj: EventObj
  - Rest ...values: any[]
  Returns boolean

engineEvents

engineEvents: typeof engineEventsEnums = engineEventsEnums

waitForActiveEventMs

waitForActiveEventMs: number = 5000

`Static` `Private` #defaultEngineEventHandler

#defaultEngineEventHandler: ((this: Engine, eventName: string | string[], eventObj: EventObj) => void) = ...

Type declaration

- (this: Engine, eventName: string | string[], eventObj: EventObj): void
- The default event hander prints all events on the console/stdout. Additionally, it:
  - stops the stream on receiving an "engineProcess.stream.error" event 5 times
  Parameters
  - this: Engine
    
    Engine
  - eventName: string | string[]
    
    the name of the event
  - eventObj: EventObj
    
    the event object of type EventObj containing event information
  Returns void

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

numStreams

get numStreams(): number
Returns number
- Defined in src/engine/engine.ts:227

Methods

`Private` #createAxiosInstance

#createAxiosInstance(): Promise<void>
Returns Promise<void>
- Defined in src/engine/engine.ts:419

`Private` #setEngineConfig

#setEngineConfig(receivedEngineConfig: Partial<EngineConfig>): Promise<void>
internal API that sets the engine config. called from the constructor and updateEngineConfigs method
Parameters
- receivedEngineConfig: Partial<EngineConfig>
Returns Promise<void>
- Defined in src/engine/engine.ts:267

`Private` #setEngineExtraConfig

#setEngineExtraConfig(receivedEngineExtraConfig: Partial<EngineExtraConfig>): Promise<void>
internal API that sets the engine extraConfig. called from the constructor and updateEngineConfigs method
Parameters
- receivedEngineExtraConfig: Partial<EngineExtraConfig>
Returns Promise<void>
- Defined in src/engine/engine.ts:331

`Private` #startMgmtEvents

#startMgmtEvents(): Promise<void>
Returns Promise<void>
- Defined in src/engine/engine.ts:951

`Protected` _apiDeleteStream

_apiDeleteStream(stream: Stream, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- stream: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiDeleteStream
- Defined in src/engine/engineProcessAPI.ts:147

`Protected` _apiGetPing

_apiGetPing(axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiGetPing
- Defined in src/engine/engineProcessAPI.ts:38

`Protected` _apiGetReady

_apiGetReady(axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiGetReady
- Defined in src/engine/engineProcessAPI.ts:50

`Protected` _apiGetStream

_apiGetStream(stream: Stream, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<{ active: boolean; config: TStreamConfig; uptime: number; uptime_str: string }, any>>
Parameters
- stream: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<{ active: boolean; config: TStreamConfig; uptime: number; uptime_str: string }, any>>
Inherited from EngineProcessAPI._apiGetStream
- Defined in src/engine/engineProcessAPI.ts:102

`Protected` _apiGetStreamReady

_apiGetStreamReady(stream: Stream, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- stream: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiGetStreamReady
- Defined in src/engine/engineProcessAPI.ts:62

`Protected` _apiGetStreams

_apiGetStreams(axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<{ [streamID: string]: { active: boolean; uptime: BigInt; uptime_str: string } }, any>>
Parameters
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<{ [streamID: string]: { active: boolean; uptime: BigInt; uptime_str: string } }, any>>
Inherited from EngineProcessAPI._apiGetStreams
- Defined in src/engine/engineProcessAPI.ts:18

`Protected` _apiPostStream

_apiPostStream(stream: Stream, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- stream: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiPostStream
- Defined in src/engine/engineProcessAPI.ts:125

`Protected` _apiPostStreams

_apiPostStreams(streamsMap: { [key: string]: Stream }, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- streamsMap: { [key: string]: Stream }
  - [key: string]: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiPostStreams
- Defined in src/engine/engineProcessAPI.ts:78

`Protected` _apiPutStream

_apiPutStream(stream: Stream, axiosReqConfig?: AxiosRequestConfig<any>): Promise<AxiosResponse<string, any>>
Parameters
- stream: Stream
- axiosReqConfig: AxiosRequestConfig<any> = {}
Returns Promise<AxiosResponse<string, any>>
Inherited from EngineProcessAPI._apiPutStream
- Defined in src/engine/engineProcessAPI.ts:166

add

add(...streams: Stream[]): Promise<Engine>
adds one or more streams to the engine
Parameters
- Rest ...streams: Stream[]
Returns Promise<Engine>
- Defined in src/engine/engine.ts:1063

addListener

addListener(event: string | symbol | event[], listener: ListenerFn): Engine | Listener
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
Returns Engine | Listener
Inherited from EngineProcessAPI.addListener
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:121

emitAsync

emitAsync(event: string | symbol | event[], ...values: any[]): Promise<any[]>
Parameters
- event: string | symbol | event[]
- Rest ...values: any[]
Returns Promise<any[]>
Inherited from EngineProcessAPI.emitAsync
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:120

eventNames

eventNames(nsAsArray?: boolean): (string | symbol | event[])[]
Parameters
- Optional nsAsArray: boolean
Returns (string | symbol | event[])[]
Inherited from EngineProcessAPI.eventNames
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:136

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EngineProcessAPI.getMaxListeners
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:135

hasListeners

hasListeners(event?: String): Boolean
Parameters
- Optional event: String
Returns Boolean
Inherited from EngineProcessAPI.hasListeners
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:147

listenTo

listenTo(target: GeneralEventEmitter, events: string | symbol | event[], options?: ListenToOptions): Engine
Parameters
- target: GeneralEventEmitter
- events: string | symbol | event[]
- Optional options: ListenToOptions
Returns Engine
Inherited from EngineProcessAPI.listenTo
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:143
listenTo(target: GeneralEventEmitter, events: event[], options?: ListenToOptions): Engine
Parameters
- target: GeneralEventEmitter
- events: event[]
- Optional options: ListenToOptions
Returns Engine
Inherited from EngineProcessAPI.listenTo
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:144
listenTo(target: GeneralEventEmitter, events: Object, options?: ListenToOptions): Engine
Parameters
- target: GeneralEventEmitter
- events: Object
- Optional options: ListenToOptions
Returns Engine
Inherited from EngineProcessAPI.listenTo
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:145

listenerCount

listenerCount(event?: string | symbol | event[]): number
Parameters
- Optional event: string | symbol | event[]
Returns number
Inherited from EngineProcessAPI.listenerCount
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:137

listeners

listeners(event?: string | symbol | event[]): ListenerFn[]
Parameters
- Optional event: string | symbol | event[]
Returns ListenerFn[]
Inherited from EngineProcessAPI.listeners
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:138

listenersAny

listenersAny(): ListenerFn[]
Returns ListenerFn[]
Inherited from EngineProcessAPI.listenersAny
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:139

many

many(event: string | symbol | event[], timesToListen: number, listener: ListenerFn, options?: boolean | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- timesToListen: number
- listener: ListenerFn
- Optional options: boolean | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.many
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:126

off

off(event: string | symbol | event[], listener: ListenerFn): Engine
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
Returns Engine
Inherited from EngineProcessAPI.off
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:132

offAny

offAny(listener: ListenerFn): Engine
Parameters
- listener: ListenerFn
Returns Engine
Inherited from EngineProcessAPI.offAny
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:130

on

on(event: string | symbol | event[], listener: ListenerFn, options?: boolean | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
- Optional options: boolean | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.on
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:122

onAny

onAny(listener: EventAndListener): Engine
Parameters
- listener: EventAndListener
Returns Engine
Inherited from EngineProcessAPI.onAny
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:128

once

once(event: string | symbol | event[], listener: ListenerFn, options?: true | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
- Optional options: true | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.once
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:124

prependAny

prependAny(listener: EventAndListener): Engine
Parameters
- listener: EventAndListener
Returns Engine
Inherited from EngineProcessAPI.prependAny
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:129

prependListener

prependListener(event: string | symbol | event[], listener: ListenerFn, options?: boolean | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
- Optional options: boolean | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.prependListener
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:123

prependMany

prependMany(event: string | symbol | event[], timesToListen: number, listener: ListenerFn, options?: boolean | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- timesToListen: number
- listener: ListenerFn
- Optional options: boolean | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.prependMany
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:127

prependOnceListener

prependOnceListener(event: string | symbol | event[], listener: ListenerFn, options?: boolean | OnOptions): Engine | Listener
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
- Optional options: boolean | OnOptions
Returns Engine | Listener
Inherited from EngineProcessAPI.prependOnceListener
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:125

remove

remove(): Promise<Engine>
removes a stream from the engine no parameters => all added streams will be removed

Returns Promise<Engine>
- Defined in src/engine/engine.ts:1203
remove(...streams: Stream[]): Promise<Engine>
Parameters
- Rest ...streams: Stream[]
Returns Promise<Engine>
- Defined in src/engine/engine.ts:1204
remove(reason: string, ...streams: Stream[]): Promise<Engine>
Parameters
- reason: string
- Rest ...streams: Stream[]
Returns Promise<Engine>
- Defined in src/engine/engine.ts:1205

removeAllListeners

removeAllListeners(event?: string | symbol | event[]): Engine
Parameters
- Optional event: string | symbol | event[]
Returns Engine
Inherited from EngineProcessAPI.removeAllListeners
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:133

removeListener

removeListener(event: string | symbol | event[], listener: ListenerFn): Engine
Parameters
- event: string | symbol | event[]
- listener: ListenerFn
Returns Engine
Inherited from EngineProcessAPI.removeListener
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:131

setMaxListeners

setMaxListeners(n: number): void
Parameters
- n: number
Returns void
Inherited from EngineProcessAPI.setMaxListeners
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:134

start

start(): Promise<Engine>
start the engine, and the streams already added to it. for remote engines, it will start the mgmt process e.g. ping, cleanup etc.

Returns

Returns Promise<Engine>
- Defined in src/engine/engine.ts:453

stop

stop(): Promise<Engine>
stop the engine and all its streams TODO: verify that stream closes gracefully else revert to execa kill("SIGTERM")

Returns Promise<Engine>
- Defined in src/engine/engine.ts:877
stop(reason: string): Promise<Engine>
Parameters
- reason: string
Returns Promise<Engine>
- Defined in src/engine/engine.ts:878
stop(reason: string, force: boolean): Promise<Engine>
Parameters
- reason: string
- force: boolean
Returns Promise<Engine>
- Defined in src/engine/engine.ts:879

stopListeningTo

stopListeningTo(target?: GeneralEventEmitter, event?: string | symbol | event[]): Boolean
Parameters
- Optional target: GeneralEventEmitter
- Optional event: string | symbol | event[]
Returns Boolean
Inherited from EngineProcessAPI.stopListeningTo
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:146

update

update(...streams: Stream[]): Promise<Engine>
updates one or more existing streams on the engine

Returns
Parameters
- Rest ...streams: Stream[]
Returns Promise<Engine>
- Defined in src/engine/engine.ts:1139

updateEngineConfigs

updateEngineConfigs(receivedEngineConfig?: Partial<EngineConfig>, receivedEngineExtraConfig?: Partial<EngineExtraConfig>): Promise<void>
Parameters
- receivedEngineConfig: Partial<EngineConfig> = {}
- receivedEngineExtraConfig: Partial<EngineExtraConfig> = {}
Returns Promise<void>
- Defined in src/engine/engine.ts:236

useDefaultEventHandler

useDefaultEventHandler(addnEventHandlers?: { [eventName: string]: ListenerFn }): void
use the default event handler, and optinally provide additional event handlers for custom logic
Parameters
- addnEventHandlers: { [eventName: string]: ListenerFn } = {}
  - [eventName: string]: ListenerFn
Returns void
- Defined in src/engine/engine.ts:1378

waitFor

waitFor(event: string | symbol | event[], timeout?: number): CancelablePromise<any[]>
Parameters
- event: string | symbol | event[]
- Optional timeout: number
Returns CancelablePromise<any[]>
Inherited from EngineProcessAPI.waitFor
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:140
waitFor(event: string | symbol | event[], filter?: WaitForFilter): CancelablePromise<any[]>
Parameters
- event: string | symbol | event[]
- Optional filter: WaitForFilter
Returns CancelablePromise<any[]>
Inherited from EngineProcessAPI.waitFor
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:141
waitFor(event: string | symbol | event[], options?: WaitForOptions): CancelablePromise<any[]>
Parameters
- event: string | symbol | event[]
- Optional options: WaitForOptions
Returns CancelablePromise<any[]>
Inherited from EngineProcessAPI.waitFor
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:142

`Static` `Private` #writeToEngineConfigFilePath

#writeToEngineConfigFilePath(this: Engine): void
Parameters
- this: Engine
Returns void
- Defined in src/engine/engine.ts:1305

`Static` once

once(emitter: EventEmitter2, event: string | symbol | event[], options?: OnceOptions): CancelablePromise<any[]>
Parameters
- emitter: EventEmitter2
- event: string | symbol | event[]
- Optional options: OnceOptions
Returns CancelablePromise<any[]>
Inherited from EngineProcessAPI.once
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:148

Class Engine

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engineConfig: Partial<EngineConfig> = {}

engineExtraConfig: Partial<EngineExtraConfig> = {}

Returns Engine

Properties

Private #abortController

Private #benthosEXEFullPath

Private #constructorDone

Private #debug

Private #debugLog

Private #engineConfig

Private Readonly #engineConfigFilePath

Private #engineConstrStartStopMutex

Private #engineExtraConfig

Private #engineProcess

Private #engineStreamAddUpdateRemoveMutex

Private #engineUpdateConfigOptionsMutex

Private #eventLog

Private #eventNameToEventLog

Private #isActive

Private #keepAliveInterval

Private #mgmtEventsFreqMs

Private #scheme

Private #streamsMap

Type declaration

[key: string]: Stream

Private #tempLocalServer

Private #traceLog

Protected _axiosInstance

emit

Type declaration

Parameters

event: engineEventsTypes

eventObj: EventObj

Rest ...values: any[]

Returns boolean

engineEvents

waitForActiveEventMs

Static Private #defaultEngineEventHandler

Type declaration

Parameters

this: Engine

eventName: string | string[]

eventObj: EventObj

Returns void

Static defaultMaxListeners

Accessors

numStreams

Returns number

Methods

Private #createAxiosInstance

Returns Promise<void>

Private #setEngineConfig

Parameters

receivedEngineConfig: Partial<EngineConfig>

Returns Promise<void>

Private #setEngineExtraConfig

Parameters

receivedEngineExtraConfig: Partial<EngineExtraConfig>

Returns Promise<void>

Private #startMgmtEvents

Returns Promise<void>

Protected _apiDeleteStream

Parameters

stream: Stream

axiosReqConfig: AxiosRequestConfig<any> = {}

Returns Promise<AxiosResponse<string, any>>

Protected _apiGetPing

Parameters

axiosReqConfig: AxiosRequestConfig<any> = {}

`Private` #abortController

`Private` #benthosEXEFullPath

`Private` #constructorDone

`Private` #debug

`Private` #debugLog

`Private` #engineConfig

`Private` `Readonly` #engineConfigFilePath

`Private` #engineConstrStartStopMutex

`Private` #engineExtraConfig

`Private` #engineProcess

`Private` #engineStreamAddUpdateRemoveMutex

`Private` #engineUpdateConfigOptionsMutex

`Private` #eventLog

`Private` #eventNameToEventLog

`Private` #isActive

`Private` #keepAliveInterval

`Private` #mgmtEventsFreqMs

`Private` #scheme

`Private` #streamsMap

`Private` #tempLocalServer

`Private` #traceLog

`Protected` _axiosInstance

`Rest` ...values: any[]

`Static` `Private` #defaultEngineEventHandler

`Static` defaultMaxListeners

`Private` #createAxiosInstance

`Private` #setEngineConfig

`Private` #setEngineExtraConfig

`Private` #startMgmtEvents

`Protected` _apiDeleteStream

`Protected` _apiGetPing

`Protected` _apiGetReady

`Protected` _apiGetStream

`Protected` _apiGetStreamReady

`Protected` _apiGetStreams

`Protected` _apiPostStream

`Protected` _apiPostStreams

`Protected` _apiPutStream

`Rest` ...streams: Stream[]

`Rest` ...values: any[]

`Optional` nsAsArray: boolean

`Optional` event: String

`Optional` options: ListenToOptions

`Optional` options: ListenToOptions