Class ExternalApiEventStreamImpl<T>

Default implementation of the ExternalApiEventStream.

Type Parameters

T = unknown

Implements

ExternalApiEventStream<T>

Index

Constructors

Properties

broadcastTimer? clients disposed heartbeatTimer? logger options

Accessors

clientCount coalesceDelay heartbeatInterval

Methods

dispose handle notifyChanged send sendHeartbeat sendSnapshot stopTimers write

Constructors

constructor

new ExternalApiEventStreamImpl<T = unknown>(): ExternalApiEventStreamImpl<T>
Type Parameters
- T = unknown
Returns ExternalApiEventStreamImpl<T>

Properties

`Protected` `Optional`broadcastTimer

broadcastTimer?: Timeout

`Protected` `Readonly`clients

clients: Set<Response<any, Record<string, any>>> = ...

Open server-sent event streams, one per connected client.

`Protected`disposed

disposed: boolean = false

`Protected` `Optional`heartbeatTimer

heartbeatTimer?: Timeout

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`options

options: ExternalApiEventStreamOptions<T>

Accessors

clientCount

get clientCount(): number
The number of currently connected clients.

Returns number
Implementation of ExternalApiEventStream.clientCount
- Defined in external-api/src/node/external-api-event-stream.ts:100

`Protected`coalesceDelay

get coalesceDelay(): number
Returns number
- Defined in external-api/src/node/external-api-event-stream.ts:189

`Protected`heartbeatInterval

get heartbeatInterval(): number
Returns number
- Defined in external-api/src/node/external-api-event-stream.ts:193

Methods

dispose

dispose(): void
Ends all client connections and stops the timers.

Returns void
Implementation of ExternalApiEventStream.dispose
- Defined in external-api/src/node/external-api-event-stream.ts:153

handle

handle(request: Request, response: Response): Promise<void>
Serves the event stream to a client; registered as the route's request handler by ExternalApiRouter#eventStream.
Parameters
- request: Request
- response: Response
Returns Promise<void>
Implementation of ExternalApiEventStream.handle
- Defined in external-api/src/node/external-api-event-stream.ts:104

notifyChanged

notifyChanged(): void
Schedules a coalesced broadcast of a fresh snapshot to all connected clients. No-op without a configured snapshot provider or without connected clients.

Returns void
Implementation of ExternalApiEventStream.notifyChanged
- Defined in external-api/src/node/external-api-event-stream.ts:131

send

send(data: T): void
Sends the data to all connected clients immediately, bypassing the coalescing.
Parameters
- data: T
Returns void
Implementation of ExternalApiEventStream.send
- Defined in external-api/src/node/external-api-event-stream.ts:146

`Protected`sendHeartbeat

sendHeartbeat(): void
Returns void
- Defined in external-api/src/node/external-api-event-stream.ts:181

`Protected`sendSnapshot

sendSnapshot(client: Response): Promise<void>
Parameters
- client: Response
Returns Promise<void>
- Defined in external-api/src/node/external-api-event-stream.ts:163

`Protected`stopTimers

stopTimers(): void
Returns void
- Defined in external-api/src/node/external-api-event-stream.ts:197

`Protected`write

write(client: Response, data: T): void
Parameters
- client: Response
- data: T
Returns void
- Defined in external-api/src/node/external-api-event-stream.ts:175