Class Bus<TEvent>

Propagating event bus implementation.

Type parameters

TEvent: Event = Event

Hierarchy

Unit
- Bus

Implements

EventBus<TEvent>
AwareOfContainerLifecycle

Index

Constructors

constructor

Properties

Accessors

appClassApplication

Methods

Constructors

constructor

new Bus<TEvent>(): Bus<TEvent>

Inherited from Unit.constructor

Type parameters
- TEvent: Event = Event
Returns Bus<TEvent>

Properties

awareOfContainerLifecycle

awareOfContainerLifecycle: true = true

Protected Readonly config

config: Config

Protected connectors

connectors: Collection<EventBus<Event>> = ...

Connections to other event busses to be propagated.

Private isUp

isUp: boolean = false

True if the bus has been initialized.

Protected Readonly logging

logging: Logging

status

status: UnitStatus = ...

The current status of the unit.

Protected subscribers

subscribers: Collection<BusSubscriber<Event>> = ...

Local listeners subscribed to events on this bus.

Protected subscriptions

subscriptions: Collection<BusInternalSubscription> = ...

Readonly uuid

uuid: string = ...

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

Methods

Protected app

app(): Application

Inherited from Unit.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected callSubscribers

callSubscribers(event: TEvent): Promise<boolean>

- Defined in src/support/bus/Bus.ts:95
Call all local listeners for the given event. Returns true if the propagation of the event should be halted.

Parameters
- event: TEvent
Returns Promise<boolean>

connect

connect(bus: EventBus<Event>): Promise<void>

- Defined in src/support/bus/Bus.ts:151
Connect an external event bus to this bus.

Parameters
- bus: EventBus<Event>
Returns Promise<void>

Protected container

container(): Container

Inherited from Unit.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

disconnect

disconnect(bus: EventBus<Event>): Promise<void>

- Defined in src/support/bus/Bus.ts:176
Parameters
- bus: EventBus<Event>
Returns Promise<void>

down

down(): Promise<void>

Implementation of EventBus.down

Overrides Unit.down
- Defined in src/support/bus/Bus.ts:221
Clean up this event bus.

Returns Promise<void>

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from Unit.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

isConnected

isConnected(): boolean

Implementation of EventBus.isConnected
- Defined in src/support/bus/Bus.ts:172
Returns boolean

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from Unit.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

onContainerDestroy

onContainerDestroy(): Awaitable<void>

Implementation of AwareOfContainerLifecycle.onContainerDestroy
- Defined in src/support/bus/Bus.ts:236
Called before the parent container of this instance is destroyed.

Returns Awaitable<void>

pipe

pipe<T>(eventKey: StaticInstantiable<T>, line: Pipeline<T, EventHandlerReturn>): Awaitable<EventHandlerSubscription>

Implementation of EventBus.pipe
- Defined in src/support/bus/Bus.ts:104
Register a pipeline as an event handler.

Type parameters
- T: Event
Parameters
- eventKey: StaticInstantiable<T>
- line: Pipeline<T, EventHandlerReturn>
Returns Awaitable<EventHandlerSubscription>

push

push(event: TEvent): Promise<void>

Implementation of EventBus.push
- Defined in src/support/bus/Bus.ts:54
Push an event onto the bus.

Parameters
- event: TEvent
Returns Promise<void>

Protected shouldBroadcast

shouldBroadcast(event: Event): Promise<boolean>

- Defined in src/support/bus/Bus.ts:81
Returns true if the given event should be pushed to connected event busses.

Parameters
- event: Event
Returns Promise<boolean>

subscribe

subscribe<T>(eventKey: StaticInstantiable<T>, handler: EventHandler<T>): Promise<EventHandlerSubscription>

Implementation of EventBus.subscribe
- Defined in src/support/bus/Bus.ts:113
Subscribe to an event on the bus.

Type parameters
- T: Event
Parameters
- eventKey: StaticInstantiable<T>
- handler: EventHandler<T>
Returns Promise<EventHandlerSubscription>

up

up(createUpstreamFromConfig?: boolean): Promise<void>

Implementation of EventBus.up

Overrides Unit.up
- Defined in src/support/bus/Bus.ts:191
Initialize this event bus.

Parameters
- createUpstreamFromConfig: boolean = true
Returns Promise<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.