Class InMemoryChannel

Hierarchy

BaseChannel
- InMemoryChannel

Index

Constructors

Properties

_chainID _db _logger _moduleDB bus endpointHandlers endpointsList eventsList namespace

Methods

_getNextRequestId invoke isValidActionName isValidEventName once publish registerToBus subscribe unsubscribe

Constructors

constructor

new InMemoryChannel(logger: Logger, db: StateDB, moduleDB: Database, namespace: string, events: readonly string[], endpoints: EndpointHandlers, chainID: Buffer): InMemoryChannel
Parameters
- logger: Logger
- db: StateDB
- moduleDB: Database
- namespace: string
- events: readonly string[]
- endpoints: EndpointHandlers
- chainID: Buffer
Returns InMemoryChannel
Overrides BaseChannel.constructor
- Defined in framework/src/controller/channels/in_memory_channel.ts:34

Properties

`Private` `Readonly` _chainID

_chainID: Buffer

`Private` `Readonly` _db

_db: StateDB

`Protected` `Readonly` _logger

_logger: Logger

`Private` `Readonly` _moduleDB

_moduleDB: Database

`Private` bus

bus: Bus

`Protected` `Readonly` endpointHandlers

endpointHandlers: EndpointHandlers

`Readonly` endpointsList

endpointsList: readonly string[]

`Readonly` eventsList

eventsList: readonly string[]

`Readonly` namespace

namespace: string

Methods

`Protected` _getNextRequestId

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

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/in_memory_channel.ts:96

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: EventCallback): void
Parameters
- eventName: string
- cb: EventCallback
Returns void
Overrides BaseChannel.once
- Defined in framework/src/controller/channels/in_memory_channel.ts:79

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/in_memory_channel.ts:86

registerToBus

registerToBus(bus: Bus): Promise<void>
Parameters
- bus: Bus
Returns Promise<void>
Overrides BaseChannel.registerToBus
- Defined in framework/src/controller/channels/in_memory_channel.ts:49

subscribe

subscribe(eventName: string, cb: EventCallback): void
Parameters
- eventName: string
- cb: EventCallback
Returns void
Overrides BaseChannel.subscribe
- Defined in framework/src/controller/channels/in_memory_channel.ts:68

unsubscribe

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

Generated using TypeDoc