Interface EventStream

The EventStream interface implements a pub/sub system based on Message filters.

interface EventStream {
    close(): Promise<void>;
    emit(tenant: string, event: MessageEvent, indexes: KeyValues): void;
    open(): Promise<void>;
    subscribe(tenant: string, id: string, listener: EventListener): Promise<EventSubscription>;
}

Implemented by

EventEmitterStream

Index

Methods

close emit open subscribe

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/types/subscriptions.ts:24

emit

emit(tenant, event, indexes): void
Parameters
- tenant: string
- event: MessageEvent
- indexes: KeyValues
Returns void
- Defined in src/types/subscriptions.ts:22

open

open(): Promise<void>
Returns Promise<void>
- Defined in src/types/subscriptions.ts:23

subscribe

subscribe(tenant, id, listener): Promise<EventSubscription>
Parameters
- tenant: string
- id: string
- listener: EventListener
Returns Promise<EventSubscription>
- Defined in src/types/subscriptions.ts:21