Mokksy/dev.mokksy.mokksy.response/SseStreamResponseDefinition

SseStreamResponseDefinition

open class SseStreamResponseDefinition<P>(val chunkFlow: Flow<ServerSentEvent>? = null, chunkContentType: ContentType? = null, delay: Duration = Duration.ZERO, formatter: HttpFormatter) : StreamResponseDefinition<P, ServerSentEvent> (source)

Represents a response definition for server-sent events (SSE) streaming.

This class extends StreamResponseDefinition and is used to configure and handle an SSE response. It provides functionality for sending a stream of SSE events to the client, utilizing a specified chunkFlow and configuring response metadata.

Author

Konstantin Pavlov

Parameters

The payload type for the SSE events.

chunkFlow

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

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.

Constructors

SseStreamResponseDefinition

constructor(chunkFlow: Flow<ServerSentEvent>? = null, chunkContentType: ContentType? = null, delay: Duration = Duration.ZERO, formatter: HttpFormatter)