ktor-client-core/io.ktor.client.plugins.sse/SSEConfig

SSEConfig

class SSEConfig(source)

A config for the SSE plugin.

Report a problem

Constructors

SSEConfig

constructor()

Properties

bufferPolicy

var bufferPolicy: SSEBufferPolicy

Controls how the plugin captures a diagnostic buffer of the SSE stream that has already been processed, so you can inspect it when an exception occurs.

maxReconnectionAttempts

var maxReconnectionAttempts: Int

The maximum amount of retries to perform for a reconnection request. To enable reconnection, set this value to a number greater than 0.

reconnectionTime

var reconnectionTime: Duration

The reconnection time. If the connection to the server is lost, the client will wait for the specified time before attempting to reconnect.

Functions

showCommentEvents

fun showCommentEvents()

Adds events consisting only of comments in the incoming flow.

showRetryEvents

fun showRetryEvents()

Adds events consisting only of the retry field in the incoming flow.