Interface SseChannel

A named broadcast channel within the SSE hub.

Multiple connections may subscribe to a channel; publishing a message to the channel delivers it to every open member. Closed members are silently skipped during broadcast.

Since

0.1.0

interface SseChannel {
    size: number;
    add(conn: ISseConnection): void;
    publish(msg: SseMessage): void;
    remove(conn: ISseConnection): void;
}

Index

Properties

Methods

add publish remove

Properties

`Readonly`size

size: number

Number of currently open connections in this channel.

Methods

add

add(conn: ISseConnection): void
Adds a connection to this channel's membership.
Parameters
- conn: ISseConnection
  The connection to add
Returns void
- Defined in packages/common/src/services/sse.ts:110

publish

publish(msg: SseMessage): void
Publishes a message to every open member of this channel, skipping any connection whose ISseConnection.isOpen is false.
Parameters
- msg: SseMessage
  The message to broadcast
Returns void
- Defined in packages/common/src/services/sse.ts:123

remove

remove(conn: ISseConnection): void
Removes a connection from this channel's membership.
Parameters
- conn: ISseConnection
  The connection to remove
Returns void
- Defined in packages/common/src/services/sse.ts:116