Mokksy/dev.mokksy.mokksy.response/SseStreamResponseDefinition

SseStreamResponseDefinition

class SseStreamResponseDefinition<T> : StreamResponseDefinition<ServerSentEventMetadata<T>> (source)

A StreamResponseDefinition specialization for server-sent events.

Overrides configureHeaders to add SSE-specific headers and serialize to append a blank-line event terminator (\r\n) after each event per the SSE specification.

Author

Konstantin Pavlov

Parameters

chunkFlow

A Flow of ServerSentEvent representing the stream of SSE events. Defaults to emptyFlow.

chunkContentType

The ContentType for the chunks in the SSE stream. Defaults to null.

delay

An optional delay between chunks, specified as a Duration. Defaults to Duration.ZERO.

formatter

An HttpFormatter responsible for formatting the HTTP response or payloads.

Properties

chunkFlow

open override val chunkFlow: Flow<ServerSentEventMetadata<T>>

contentType

val contentType: ContentType

The MIME type of the response content.

delay

open val delay: Duration

A delay applied before sending the response. Defaults to Duration.ZERO.

delayBetweenChunks

val delayBetweenChunks: Duration

Delay between the transmission of each chunk.

headers

val headers: ResponseHeaders.() -> Unit?

A lambda that configures the response headers. Defaults to null.

httpStatus

val httpStatus: HttpStatusCode

The HTTP status code of the response. Defaults to HttpStatusCode.OK.