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

ClientSSESessionWithDeserialization

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

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

Report a problem

Constructors

Link copied to clipboard
constructor(call: HttpClientCall, delegate: SSESessionWithDeserialization)

Properties

Link copied to clipboard
val call: HttpClientCall

The HTTP call associated with the session.

Link copied to clipboard
open override val coroutineContext: CoroutineContext
Link copied to clipboard
open override val deserializer: (TypeInfo, String) -> Any?

Deserializer for transforming the data field of a ServerSentEvent into a desired data object.

Link copied to clipboard
open override val incoming: Flow<TypedServerSentEvent<String>>

An incoming Server-Sent Events (SSE) flow.

Functions

Link copied to clipboard
open override fun bodyBuffer(): ByteArray

Returns a diagnostic buffer of SSE data that has already been processed by this session.

Link copied to clipboard
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.