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

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( 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)

suspend fun HttpClient.sse( urlString: String, 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.

Report a problem

Parameters

reconnectionTime

The time duration to wait before attempting reconnection in case of connection loss

showCommentEvents

When enabled, events containing only comments field will be presented in the incoming flow

showRetryEvents

When enabled, events containing only comments field will be presented in the incoming flow

Example of usage:

client.sse("http://localhost:8080/sse") { // `this` is `ClientSSESession`
    incoming.collect { event ->
        println("Id: ${event.id}")
        println("Event: ${event.event}")
        println("Data: ${event.data}")
    }
}

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( 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)

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)

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.

Report a problem

Parameters

deserialize

The deserializer function to transform the data field of the TypedServerSentEvent into an object

reconnectionTime

The time duration to wait before attempting reconnection in case of connection loss

showCommentEvents

When enabled, events containing only comments field will be presented in the incoming flow

showRetryEvents

When enabled, events containing only comments field will be presented in the incoming flow

Example of usage:

client.sse({
    url("http://localhost:8080/sse")
}, deserialize = {
    typeInfo, jsonString ->
    val serializer = Json.serializersModule.serializer(typeInfo.kotlinType!!)
    Json.decodeFromString(serializer, jsonString)!!
}) { // `this` is `ClientSSESessionWithDeserialization`
    incoming.collect { event: TypedServerSentEvent<String> ->
        when (event.event) {
            "customer" -> {
                val customer: Customer? = deserialize<Customer>(event.data)
            }
            "product" -> {
                val product: Product? = deserialize<Product>(event.data)
            }
        }
    }
}