ktor-server-sse/io.ktor.server.sse

Package-level declarations

Types

interface ServerSSESession : CoroutineScope

Represents a server-side server-sent events session. An ServerSSESession allows the server to send ServerSentEvent to the client over a single HTTP connection.

SSEServerContent

class SSEServerContent(val call: ApplicationCall, val handle: suspend ServerSSESession.() -> Unit) : OutgoingContent.WriteChannelContent

An OutgoingContent response object that could be used to respond(). It will start Server-Sent events SSE session.

Properties

SSE

val SSE: ApplicationPlugin<Unit>

Server-Sent Events (SSE) support plugin. It is required to be installed first before binding any sse endpoints.

Functions

sse

fun Route.sse(handler: suspend ServerSSESession.() -> Unit)

Adds a route to handle Server-Sent Events (SSE) using the provided handler. Requires SSE plugin to be installed.

fun Route.sse(path: String, handler: suspend ServerSSESession.() -> Unit)

Adds a route to handle Server-Sent Events (SSE) at the specified path using the provided handler. Requires SSE plugin to be installed.