Class RedisBus

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

Hierarchy

RedisBus

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RedisBus(): RedisBus

Returns RedisBus

Properties

awareOfContainerLifecycle

awareOfContainerLifecycle: true = 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>

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

Protected handleEvent

handleEvent(name: string, payload: string): Promise<void>

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

isConnected

isConnected(): boolean

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

onContainerRelease

onContainerRelease(): Awaitable<void>

Implementation of AwareOfContainerLifecycle.onContainerRelease
- Defined in src/support/bus/RedisBus.ts:132
Called before an instance of a key is released from the container.

Returns Awaitable<void>

pipe

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

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

push

push(event: Event): Promise<void>

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

subscribe

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

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

up

up(): Promise<void>

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

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

Extollo is a free & libre application framework in TypeScript.