Mokksy/dev.mokksy.mokksy.response/StreamResponseDefinition

StreamResponseDefinition

open class StreamResponseDefinition<P, T>(val chunkFlow: Flow<T>? = null, val chunks: List<T>? = null, val delayBetweenChunks: Duration = Duration.ZERO, contentType: ContentType = ContentType.Text.EventStream.withCharset(Charsets.UTF_8), chunkContentType: ContentType? = null, httpStatusCode: Int = 200, httpStatus: HttpStatusCode = HttpStatusCode.fromValue(httpStatusCode), headers: ResponseHeaders.() -> Unit? = null, delay: Duration, formatter: HttpFormatter) : AbstractResponseDefinition<T> (source)

Represents a definition for streaming responses, supporting chunked data and flow-based content streaming. This class extends the base AbstractResponseDefinition to provide additional functionality specific to chunked or streamed responses. It can handle flow-based content delivery, manage chunk-wise delays, and supports various output formats such as OutputStream, Writer, or ServerSSESession.

Author

Konstantin Pavlov

Parameters

The type of the request body.

The type of the response data being streamed.

Inheritors

SseStreamResponseDefinition

Constructors

StreamResponseDefinition

constructor(chunkFlow: Flow<T>? = null, chunks: List<T>? = null, delayBetweenChunks: Duration = Duration.ZERO, contentType: ContentType = ContentType.Text.EventStream.withCharset(Charsets.UTF_8), chunkContentType: ContentType? = null, httpStatusCode: Int = 200, httpStatus: HttpStatusCode = HttpStatusCode.fromValue(httpStatusCode), headers: ResponseHeaders.() -> Unit? = null, delay: Duration, formatter: HttpFormatter)

Initializes a streaming response definition with the specified flow, chunk list, content type, HTTP status code, and headers.