Class RedisBus

Event bus implementation that does pub/sub over a Redis connection.

Hierarchy

RedisBus

Implements

Index

Constructors

Properties

awareOfContainerLifecycle injector internalSubscriptions logging publisherConnection? redis serial subscriberConnection? subscriptions uuid

Methods

down handleEvent isConnected onContainerRelease pipe push subscribe up

Constructors

constructor

new RedisBus(): RedisBus
Returns RedisBus

Properties

awareOfContainerLifecycle

awareOfContainerLifecycle: true = ...

`Protected` `Readonly` injector

injector: Container

`Protected` internalSubscriptions

internalSubscriptions: string[] = []

List of events for which we have created Redis channel subscriptions.

`Protected` `Readonly` logging

logging: Logging

`Protected` `Optional` publisherConnection

publisherConnection?: Redis

`Protected` `Readonly` redis

redis: Redis

`Protected` `Readonly` serial

serial: Serialization

`Protected` `Optional` subscriberConnection

subscriberConnection?: Redis

`Protected` subscriptions

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

List of local subscriptions on this bus.

`Readonly` uuid

uuid: string = ...

Methods

down

down(): Awaitable<void>
Returns Awaitable<void>
Implementation of EventBus.down
- Defined in src/support/bus/RedisBus.ts:127

`Protected` handleEvent

handleEvent(name: string, payload: string): Promise<void>
Parameters
- name: string
- payload: string
Returns Promise<void>
- Defined in src/support/bus/RedisBus.ts:99

isConnected

isConnected(): boolean
Returns boolean
Implementation of EventBus.isConnected
- Defined in src/support/bus/RedisBus.ts:107

onContainerRelease

onContainerRelease(): Awaitable<void>
Called before an instance of a key is released from the container.

Returns Awaitable<void>
Implementation of AwareOfContainerLifecycle.onContainerRelease
- Defined in src/support/bus/RedisBus.ts:132

pipe

pipe<T>(eventKey: StaticInstantiable<T>, line: Pipeline<T, EventHandlerReturn>): Awaitable<EventHandlerSubscription>
Type Parameters
- T extends Event
Parameters
- eventKey: StaticInstantiable<T>
- line: Pipeline<T, EventHandlerReturn>
Returns Awaitable<EventHandlerSubscription>
Implementation of EventBus.pipe
- Defined in src/support/bus/RedisBus.ts:41

push

push(event: Event): Promise<void>
Parameters
- event: Event
Returns Promise<void>
Implementation of EventBus.push
- Defined in src/support/bus/RedisBus.ts:45

subscribe

subscribe<T>(eventKey: StaticInstantiable<T>, handler: EventHandler<T>): Promise<EventHandlerSubscription>
Type Parameters
- T extends Event
Parameters
- eventKey: StaticInstantiable<T>
- handler: EventHandler<T>
Returns Promise<EventHandlerSubscription>
Implementation of EventBus.subscribe
- Defined in src/support/bus/RedisBus.ts:59

up

up(): Promise<void>
Returns Promise<void>
Implementation of EventBus.up
- Defined in src/support/bus/RedisBus.ts:111