Class MemoryPublisher<Evt>

Publishers provide the interface between the underlying event system and the bus. This defines the interactions the bus has with the publisher.

Type Parameters

Evt extends Respondable

Hierarchy

BasePublisher<Evt>
- MemoryPublisher

Implements

IPublisher

Constructors

constructor

new MemoryPublisher<Evt>(observableFactory: ObservableFactory, publisherOptions: IPublisherMeta): MemoryPublisher<Evt>
Type Parameters
- Evt extends Respondable
Parameters
- observableFactory: ObservableFactory
- publisherOptions: IPublisherMeta
Returns MemoryPublisher<Evt>
Overrides BasePublisher.constructor
- Defined in moirae/core/lib/publishers/memory.publisher.ts:18

Properties

`Protected` _distributor

_distributor: Distributor<Evt>

`Private` _queue

_queue: Queue<string>

`Protected` _responseMap

_responseMap: AsyncMap<ResponseWrapper<unknown>>

`Protected` _status

_status: StateTracker<ESState>

`Protected` `Readonly` _uuid

_uuid: string

`Protected` `Readonly` publisherOptions

publisherOptions: IPublisherMeta

role

role: PublisherToken

Define the role of the publisher within the application. Set via the using class

Accessors

`Protected` _key

get _key(): string
Returns string
Inherited from BasePublisher._key
- Defined in moirae/core/lib/classes/base.publisher.ts:56

Methods

acknowledgeEvent

acknowledgeEvent(event: Evt): Promise<void>
Parameters
- event: Evt
Returns Promise<void>
Inherited from BasePublisher.acknowledgeEvent
- Defined in moirae/core/lib/classes/base.publisher.ts:74

`Private` advanceBus

advanceBus(): void
Returns void
- Defined in moirae/core/lib/publishers/memory.publisher.ts:25

awaitResponse

awaitResponse(responseKey: string): Promise<ResponseWrapper<unknown>>
Await the response from a remote system
Parameters
- responseKey: string
Returns Promise<ResponseWrapper<unknown>>
Implementation of IPublisher.awaitResponse

Inherited from BasePublisher.awaitResponse
- Defined in moirae/core/lib/classes/base.publisher.ts:79

beforeApplicationShutdown

beforeApplicationShutdown(): Promise<void>
Returns Promise<void>
Inherited from BasePublisher.beforeApplicationShutdown
- Defined in moirae/core/lib/classes/base.publisher.ts:87

`Protected` getRoleConfig

getRoleConfig<T>(): T
Get specific configuration given the publisher role
Type Parameters
- T extends IPublisherConfig
Returns T
Inherited from BasePublisher.getRoleConfig
- Defined in moirae/core/lib/classes/base.publisher.ts:63

`Protected` handleAcknowledge

handleAcknowledge(): Promise<void>
Returns Promise<void>
Overrides BasePublisher.handleAcknowledge
- Defined in moirae/core/lib/publishers/memory.publisher.ts:38

`Protected` handleBootstrap

handleBootstrap(): Promise<void>
Returns Promise<void>
Overrides BasePublisher.handleBootstrap
- Defined in moirae/core/lib/publishers/memory.publisher.ts:42

`Protected` handlePublish

handlePublish(eventString: string): Promise<void>
Parameters
- eventString: string
Returns Promise<void>
Overrides BasePublisher.handlePublish
- Defined in moirae/core/lib/publishers/memory.publisher.ts:46

`Protected` handleResponse

handleResponse(routingKey: string, responseJSON: string): Promise<void>
Handle publishing the response outbound
Parameters
- routingKey: string
- responseJSON: string
Returns Promise<void>
Overrides BasePublisher.handleResponse
- Defined in moirae/core/lib/publishers/memory.publisher.ts:51

`Protected` handleShutdown

handleShutdown(): Promise<void>
Returns Promise<void>
Overrides BasePublisher.handleShutdown
- Defined in moirae/core/lib/publishers/memory.publisher.ts:59

listen

listen(handlerFn: ((event: Evt) => void)): string
Listen to the publisher asynchronously without interacting with publisher state
Parameters
- handlerFn: ((event: Evt) => void)
  - - (event: Evt): void
    - Parameters
      
      event: Evt
      
      Returns void
Returns string
Implementation of IPublisher.listen

Inherited from BasePublisher.listen
- Defined in moirae/core/lib/classes/base.publisher.ts:112

onApplicationBootstrap

onApplicationBootstrap(): Promise<void>
Returns Promise<void>
Inherited from BasePublisher.onApplicationBootstrap
- Defined in moirae/core/lib/classes/base.publisher.ts:118

parseEvent

parseEvent(eventString: string): Evt
Parameters
- eventString: string
Returns Evt
Inherited from BasePublisher.parseEvent
- Defined in moirae/core/lib/mixins/event-processor.mixin.ts:9

`Protected` parseResponse

parseResponse(responseString: string): ResponseWrapper<unknown>
Parameters
- responseString: string
Returns ResponseWrapper<unknown>
Inherited from BasePublisher.parseResponse
- Defined in moirae/core/lib/classes/base.publisher.ts:133

plainToInstance

plainToInstance(event: Evt): Evt
Parameters
- event: Evt
Returns Evt
Inherited from BasePublisher.plainToInstance
- Defined in moirae/core/lib/mixins/event-processor.mixin.ts:17

publish

publish(event: Evt): Promise<void>
Publish an event to the wider system
Parameters
- event: Evt
Returns Promise<void>
Implementation of IPublisher.publish

Inherited from BasePublisher.publish
- Defined in moirae/core/lib/classes/base.publisher.ts:127

serializeEvent

serializeEvent(event: Evt): string
Convert an existing event into JSON
Parameters
- event: Evt
Returns string
Inherited from BasePublisher.serializeEvent
- Defined in moirae/core/lib/mixins/event-processor.mixin.ts:27

subscribe(handlerFn: ((event: Evt) => any)): string
Subscribe to the publisher as a worker.
Parameters
- handlerFn: ((event: Evt) => any)
  - - (event: Evt): any
    - Parameters
      
      event: Evt
      
      Returns any
Returns string
Implementation of IPublisher.subscribe

Inherited from BasePublisher.subscribe
- Defined in moirae/core/lib/classes/base.publisher.ts:141

unsubscribe

unsubscribe(key: string): void
Unsubscribe from the bus
Parameters
- key: string
Returns void
Implementation of IPublisher.unsubscribe

Inherited from BasePublisher.unsubscribe
- Defined in moirae/core/lib/classes/base.publisher.ts:159

Class MemoryPublisher<Evt>

Type Parameters

Evt extends Respondable

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Evt extends Respondable

Parameters

observableFactory: ObservableFactory

publisherOptions: IPublisherMeta

Returns MemoryPublisher<Evt>

Properties

Protected _distributor

Private _queue

Protected _responseMap

Protected _status

Protected Readonly _uuid

Protected Readonly publisherOptions

role

Accessors

Protected _key

Returns string

Methods

acknowledgeEvent

Parameters

event: Evt

Returns Promise<void>

Private advanceBus

Returns void

awaitResponse

Parameters

responseKey: string

Returns Promise<ResponseWrapper<unknown>>

beforeApplicationShutdown

Returns Promise<void>

Protected getRoleConfig

Type Parameters

T extends IPublisherConfig

Returns T

Protected handleAcknowledge

Returns Promise<void>

Protected handleBootstrap

Returns Promise<void>

Protected handlePublish

Parameters

eventString: string

Returns Promise<void>

Protected handleResponse

Parameters

routingKey: string

responseJSON: string

Returns Promise<void>

Protected handleShutdown

Returns Promise<void>

listen

Parameters

handlerFn: ((event: Evt) => void)

Parameters

event: Evt

Returns void

Returns string

onApplicationBootstrap

Returns Promise<void>

parseEvent

Parameters

eventString: string

Returns Evt

Protected parseResponse

Parameters

responseString: string

Returns ResponseWrapper<unknown>

plainToInstance

Parameters

`Protected` _distributor

`Private` _queue

`Protected` _responseMap

`Protected` _status

`Protected` `Readonly` _uuid

`Protected` `Readonly` publisherOptions

`Protected` _key

`Private` advanceBus

`Protected` getRoleConfig

`Protected` handleAcknowledge

`Protected` handleBootstrap

`Protected` handlePublish

`Protected` handleResponse

`Protected` handleShutdown

`Protected` parseResponse