Mokksy/dev.mokksy.mokksy.response/StreamingResponseDefinitionBuilder

StreamingResponseDefinitionBuilder

open class StreamingResponseDefinitionBuilder<P : Any, T> : AbstractResponseDefinitionBuilder<P, T> (source)

A builder for constructing streaming response definitions.

This class is responsible for building instances of StreamResponseDefinition, which define responses capable of streaming data either as chunks or via a flow.

Type Parameters

The type of the request body.

The type of data being streamed.

Properties

chunkContentType

val chunkContentType: ContentType?

chunks

val chunks: MutableList<T>

A list of data chunks to be sent as part of the stream, if flow is not provided.

contentType

var contentType: ContentType

The Content-Type of the HTTP response. Defaults to text/event-stream; charset=UTF-8.

delay

var delay: Duration

delayBetweenChunks

var delayBetweenChunks: Duration

flow

var flow: Flow<T>?

A Flow representing streaming data content.

headers

val headers: AbstractResponseDefinitionBuilder.HeadersConfigurer

Entry point for header configuration. Supports two syntaxes:

httpStatus

var httpStatus: HttpStatusCode

The HTTP status code of the response.

httpStatusCode

open var httpStatusCode: Int

The HTTP status code to be associated with the response.

request

val request: CapturedRequest<P>

The CapturedRequest being processed.

Functions

addHeader

fun addHeader(name: String, value: String)

Adds a single response header.