Class SseConnection

Implements IConn.

Since

0.1.0

Implements

ISseConnection

Index

Constructors

Properties

id lastEventId result

Accessors

Methods

close comment send

Constructors

constructor

new SseConnection(
    ctx: IRequestContext,
    runtime: IRuntimeServices,
    heartbeatMs: number | undefined,
    retryMs: number | undefined,
    onClosed: () => void,
): SseConnection
Parameters
- ctx: IRequestContext
- runtime: IRuntimeServices
- heartbeatMs: number | undefined
- retryMs: number | undefined
- onClosed: () => void
Returns SseConnection
- Defined in packages/sse-plugin/src/connection/sse-connection.ts:49

Properties

`Readonly`id

id: string

Unique connection ID.

`Readonly`lastEventId

lastEventId: string | null

The client's Last-Event-ID header value, if present.

`Readonly`result

result: HandlerResult

The HandlerResult obtained from ctx.response.stream() — set in constructor.

Accessors

isOpen

get isOpen(): boolean
Whether this connection is still open.

Returns boolean
Implementation of ISseConnection.isOpen
- Defined in packages/sse-plugin/src/connection/sse-connection.ts:112

Methods

close

close(): void
Close the connection (idempotent).

Returns void
Implementation of ISseConnection.close
- Defined in packages/sse-plugin/src/connection/sse-connection.ts:127

comment

comment(text: string): void
Enqueue a plain-text comment frame.
Parameters
- text: string
Returns void
Implementation of ISseConnection.comment
- Defined in packages/sse-plugin/src/connection/sse-connection.ts:122

send

send(msg: SseMessage): void
Enqueue an encoded SSE message.
Parameters
- msg: SseMessage
Returns void
Implementation of ISseConnection.send
- Defined in packages/sse-plugin/src/connection/sse-connection.ts:117