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

Package-level declarations

Types

class ClientSSESession(val call: HttpClientCall, delegate: SSESession) : SSESession

A client session for handling Server-Sent Events (SSE) from a server.

class ClientSSESessionWithDeserialization(val call: HttpClientCall, delegate: SSESessionWithDeserialization) : SSESessionWithDeserialization

A client session with deserialization support for handling Server-Sent Events (SSE) from a server.

DefaultClientSSESession

class ~~DefaultClientSSESession~~(content: SSEClientContent, input: ByteReadChannel, val coroutineContext: CoroutineContext) : SSESession

SSEBufferPolicy

sealed interface SSEBufferPolicy

Policy that controls how an SSE diagnostic buffer is captured while reading a stream.

SSECapability

data object SSECapability : HttpClientEngineCapability<Unit>

Indicates if a client engine supports Server-Sent Events (SSE).

SSEClientContent

class SSEClientContent(val reconnectionTime: Duration, val showCommentEvents: Boolean, val showRetryEvents: Boolean, val maxReconnectionAttempts: Int, val bufferPolicy: SSEBufferPolicy, val callContext: CoroutineContext, val initialRequest: HttpRequestBuilder, requestBody: OutgoingContent) : OutgoingContent.ContentWrapper

SSEClientException

class SSEClientException(val response: HttpResponse? = null, val cause: Throwable? = null, val message: String? = null) : IllegalStateException

Represents an exception which can be thrown during client SSE session.

SSEConfig

class SSEConfig

A config for the SSE plugin.

SSESession

interface SSESession : CoroutineScope

A session for handling Server-Sent Events (SSE) from a server.

SSESessionWithDeserialization

interface SSESessionWithDeserialization : CoroutineScope

A session with deserialization support for handling Server-Sent Events (SSE) from a server.

Properties

SSE

val SSE: ClientPlugin<SSEConfig>

Client Server-Sent Events (SSE) plugin that allows you to establish an SSE connection to a server and receive Server-Sent Events from it. For a simple session, use ClientSSESession. For a session with deserialization, use ClientSSESessionWithDeserialization.

Functions

bufferPolicy

fun HttpRequestBuilder.bufferPolicy(policy: 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.

deserialize

inline fun <T> SSESessionWithDeserialization.deserialize(event: TypedServerSentEvent<String>): T?

Deserialize the provided event data into an object of type T using the deserializer function defined in the SSESessionWithDeserialization interface.

inline fun <T> SSESessionWithDeserialization.deserialize(data: String?): T?

Deserialize the provided data into an object of type T using the deserializer function defined in the SSESessionWithDeserialization interface.

serverSentEvents

suspend fun HttpClient.serverSentEvents(request: HttpRequestBuilder.() -> Unit, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESession.() -> Unit)

suspend fun HttpClient.serverSentEvents(urlString: String, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientSSESession.() -> Unit)

suspend fun HttpClient.serverSentEvents(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientSSESession.() -> Unit)

Opens a ClientSSESession to receive Server-Sent Events (SSE) from a server and performs block.

suspend fun HttpClient.serverSentEvents(request: HttpRequestBuilder.() -> Unit, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

Opens a ClientSSESessionWithDeserialization to receive Server-Sent Events (SSE) from a server with ability to deserialize the data field of the TypedServerSentEvent.

suspend fun HttpClient.serverSentEvents(urlString: String, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

suspend fun HttpClient.serverSentEvents(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

Opens a ClientSSESessionWithDeserialization to receive Server-Sent Events (SSE) from a server with ability to deserialize the data field of the TypedServerSentEvent and performs block.

serverSentEventsSession

suspend fun HttpClient.serverSentEventsSession(reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit): ClientSSESession

suspend fun HttpClient.serverSentEventsSession(urlString: String, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESession

suspend fun HttpClient.serverSentEventsSession(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESession

Opens a ClientSSESession to receive Server-Sent Events (SSE) from a server.

suspend fun HttpClient.serverSentEventsSession(deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit): ClientSSESessionWithDeserialization

suspend fun HttpClient.serverSentEventsSession(urlString: String, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESessionWithDeserialization

suspend fun HttpClient.serverSentEventsSession(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESessionWithDeserialization

Opens a ClientSSESessionWithDeserialization to receive Server-Sent Events (SSE) from a server with ability to deserialize the data field of the TypedServerSentEvent.

SSE

fun HttpClientConfig<*>.SSE(config: SSEConfig.() -> Unit)

Installs the SSE plugin using the config as configuration.

sse

suspend fun HttpClient.sse(request: HttpRequestBuilder.() -> Unit, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESession.() -> Unit)

suspend fun HttpClient.sse(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESession.() -> Unit)

suspend fun HttpClient.sse(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, request: HttpRequestBuilder.() -> Unit = {}, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESession.() -> Unit)

Opens a ClientSSESession to receive Server-Sent Events (SSE) from a server and performs block.

suspend fun HttpClient.sse(request: HttpRequestBuilder.() -> Unit, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

suspend fun HttpClient.sse(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

suspend fun HttpClient.sse(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, request: HttpRequestBuilder.() -> Unit = {}, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: suspend ClientSSESessionWithDeserialization.() -> Unit)

Opens a ClientSSESessionWithDeserialization to receive Server-Sent Events (SSE) from a server with ability to deserialize the data field of the TypedServerSentEvent and performs block.

sseSession

suspend fun HttpClient.sseSession(reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit): ClientSSESession

suspend fun HttpClient.sseSession(urlString: String, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESession

suspend fun HttpClient.sseSession(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESession

Opens a ClientSSESession to receive Server-Sent Events (SSE) from a server.

suspend fun HttpClient.sseSession(deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit): ClientSSESessionWithDeserialization

suspend fun HttpClient.sseSession(urlString: String, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESessionWithDeserialization

suspend fun HttpClient.sseSession(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, deserialize: (TypeInfo, String) -> Any?, reconnectionTime: Duration? = null, showCommentEvents: Boolean? = null, showRetryEvents: Boolean? = null, block: HttpRequestBuilder.() -> Unit = {}): ClientSSESessionWithDeserialization

Opens a ClientSSESessionWithDeserialization to receive Server-Sent Events (SSE) from a server with ability to deserialize the data field of the TypedServerSentEvent and performs block.