Class BasePublisher<Evt>`Abstract`

Type Parameters

Evt extends Respondable

Hierarchy

EventProcessor<Evt>
- BasePublisher
  - MemoryPublisher

Implements

OnApplicationBootstrap
BeforeApplicationShutdown
EventProcessor<Evt>

Index

Constructors

constructor

new BasePublisher<Evt>(observableFactory: ObservableFactory, publisherOptions: IPublisherMeta): BasePublisher<Evt>
Type Parameters
- Evt extends Respondable
Parameters
- observableFactory: ObservableFactory
- publisherOptions: IPublisherMeta
Returns BasePublisher<Evt>
Overrides EventProcessor.constructor
- Defined in moirae/core/lib/classes/base.publisher.ts:41

Properties

`Protected` _distributor

_distributor: Distributor<Evt>

`Protected` _responseMap

_responseMap: AsyncMap<ResponseWrapper<unknown>>

`Protected` _status

_status: StateTracker<ESState>

`Protected` `Readonly` _uuid

_uuid: string

`Protected` `Readonly` publisherOptions

publisherOptions: IPublisherMeta

role

role: PublisherToken

Accessors

`Protected` _key

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

Methods

acknowledgeEvent

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

awaitResponse

awaitResponse(responseKey: string): Promise<ResponseWrapper<unknown>>
Parameters
- responseKey: string
Returns Promise<ResponseWrapper<unknown>>
- Defined in moirae/core/lib/classes/base.publisher.ts:79

beforeApplicationShutdown

beforeApplicationShutdown(): Promise<void>
Returns Promise<void>
Implementation of BeforeApplicationShutdown.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
- Defined in moirae/core/lib/classes/base.publisher.ts:63

`Protected` `Abstract` handleAcknowledge

handleAcknowledge(event: Evt): Promise<void>
Parameters
- event: Evt
Returns Promise<void>
- Defined in moirae/core/lib/classes/base.publisher.ts:94

`Protected` `Abstract` handleBootstrap

handleBootstrap(): Promise<void>
Returns Promise<void>
- Defined in moirae/core/lib/classes/base.publisher.ts:95

`Protected` `Abstract` handlePublish

handlePublish(eventString: string, executionDomain: string): Promise<void>
Parameters
- eventString: string
- executionDomain: string
Returns Promise<void>
- Defined in moirae/core/lib/classes/base.publisher.ts:96

`Protected` `Abstract` handleResponse

handleResponse(routingKey: string, responseJSON: string): Promise<void>
Handle publishing the response outbound
Parameters
- routingKey: string
- responseJSON: string
Returns Promise<void>
- Defined in moirae/core/lib/classes/base.publisher.ts:103

`Protected` `Abstract` handleShutdown

handleShutdown(): Promise<void>
Returns Promise<void>
- Defined in moirae/core/lib/classes/base.publisher.ts:107

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
- Defined in moirae/core/lib/classes/base.publisher.ts:112

onApplicationBootstrap

onApplicationBootstrap(): Promise<void>
Returns Promise<void>
Implementation of OnApplicationBootstrap.onApplicationBootstrap
- Defined in moirae/core/lib/classes/base.publisher.ts:118

parseEvent

parseEvent(eventString: string): Evt
Parameters
- eventString: string
Returns Evt
Implementation of EventProcessor.parseEvent

Inherited from EventProcessor.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>
- Defined in moirae/core/lib/classes/base.publisher.ts:133

plainToInstance

plainToInstance(event: Evt): Evt
Parameters
- event: Evt
Returns Evt
Implementation of EventProcessor.plainToInstance

Inherited from EventProcessor.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>
- 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
Implementation of EventProcessor.serializeEvent

Inherited from EventProcessor.serializeEvent
- Defined in moirae/core/lib/mixins/event-processor.mixin.ts:27

subscribe

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
- Defined in moirae/core/lib/classes/base.publisher.ts:141

unsubscribe

unsubscribe(key: string): void
Parameters
- key: string
Returns void
- Defined in moirae/core/lib/classes/base.publisher.ts:159

Generated using TypeDoc