Class IPCChannel

Hierarchy

BaseChannel
- IPCChannel

Index

Constructors

Properties

_chainID _emitter _ipcClient _logger _rpcRequestIds endpointHandlers endpointsList eventsList namespace

Accessors

_pubSocket _rpcClient _rpcServer _subSocket

Methods

_getNextRequestId cleanup invoke isValidActionName isValidEventName once publish registerToBus startAndListen subscribe unsubscribe

Constructors

constructor

new IPCChannel(logger: Logger, namespace: string, events: readonly string[], endpoints: EndpointHandlers, chainID: Buffer, options: ChildProcessOptions): IPCChannel
Parameters
- logger: Logger
- namespace: string
- events: readonly string[]
- endpoints: EndpointHandlers
- chainID: Buffer
- options: ChildProcessOptions
Returns IPCChannel
Overrides BaseChannel.constructor
- Defined in framework/src/controller/channels/ipc_channel.ts:37

Properties

`Private` `Readonly` _chainID

_chainID: Buffer

`Private` `Readonly` _emitter

_emitter: EventEmitter2

`Private` `Readonly` _ipcClient

_ipcClient: IPCClient

`Protected` `Readonly` _logger

_logger: Logger

`Private` `Readonly` _rpcRequestIds

_rpcRequestIds: Set<string>

`Protected` `Readonly` endpointHandlers

endpointHandlers: EndpointHandlers

`Readonly` endpointsList

endpointsList: readonly string[]

`Readonly` eventsList

eventsList: readonly string[]

`Readonly` namespace

namespace: string

Accessors

`Private` _pubSocket

get _pubSocket(): Publisher
Returns Publisher
- Defined in framework/src/controller/channels/ipc_channel.ts:267

`Private` _rpcClient

get _rpcClient(): Dealer
Returns Dealer
- Defined in framework/src/controller/channels/ipc_channel.ts:279

`Private` _rpcServer

get _rpcServer(): Router
Returns Router
- Defined in framework/src/controller/channels/ipc_channel.ts:275

`Private` _subSocket

get _subSocket(): Subscriber
Returns Subscriber
- Defined in framework/src/controller/channels/ipc_channel.ts:271

Methods

`Protected` _getNextRequestId

_getNextRequestId(): string
Returns string
Inherited from BaseChannel._getNextRequestId
- Defined in framework/src/controller/channels/base_channel.ts:75

cleanup

cleanup(_status?: number, _message?: string): void
Parameters
- Optional _status: number
- Optional _message: string
Returns void
- Defined in framework/src/controller/channels/ipc_channel.ts:263

invoke

invoke<T>(req: InvokeRequest): Promise<T>
Type Parameters
- T
Parameters
- req: InvokeRequest
Returns Promise<T>
Overrides BaseChannel.invoke
- Defined in framework/src/controller/channels/ipc_channel.ts:210

isValidActionName

isValidActionName(name: string, throwError?: boolean): boolean
Parameters
- name: string
- throwError: boolean = true
Returns boolean
Inherited from BaseChannel.isValidActionName
- Defined in framework/src/controller/channels/base_channel.ts:65

isValidEventName

isValidEventName(name: string, throwError?: boolean): boolean
Parameters
- name: string
- throwError: boolean = true
Returns boolean
Inherited from BaseChannel.isValidEventName
- Defined in framework/src/controller/channels/base_channel.ts:56

once

once(eventName: string, cb: ListenerFn): void
Parameters
- eventName: string
- cb: ListenerFn
Returns void
Overrides BaseChannel.once
- Defined in framework/src/controller/channels/ipc_channel.ts:188

publish

publish(eventName: string, data?: Record<string, unknown>): void
Parameters
- eventName: string
- Optional data: Record<string, unknown>
Returns void
Overrides BaseChannel.publish
- Defined in framework/src/controller/channels/ipc_channel.ts:197

registerToBus

registerToBus(): Promise<void>
Returns Promise<void>
Overrides BaseChannel.registerToBus
- Defined in framework/src/controller/channels/ipc_channel.ts:145

startAndListen

startAndListen(): Promise<void>
Returns Promise<void>
- Defined in framework/src/controller/channels/ipc_channel.ts:63

subscribe

subscribe(eventName: string, cb: ListenerFn): void
Parameters
- eventName: string
- cb: ListenerFn
Returns void
Overrides BaseChannel.subscribe
- Defined in framework/src/controller/channels/ipc_channel.ts:174

unsubscribe

unsubscribe(eventName: string, cb: ListenerFn): void
Parameters
- eventName: string
- cb: ListenerFn
Returns void
Overrides BaseChannel.unsubscribe
- Defined in framework/src/controller/channels/ipc_channel.ts:183

Generated using TypeDoc