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

Package-level declarations

Types

Link copied to clipboard
class ClientSSESession(val call: HttpClientCall, delegate: SSESession) : SSESession

A client Server-sent events session.

Link copied to clipboard
class DefaultClientSSESession(content: SSEClientContent, input: ByteReadChannel, val coroutineContext: CoroutineContext) : SSESession
Link copied to clipboard
object SSECapability : HttpClientEngineCapability<Unit>

Indicates if a client engine supports Server-sent events.

Link copied to clipboard
class SSEClientContent(    val reconnectionTime: Duration,     val showCommentEvents: Boolean,     val showRetryEvents: Boolean,     requestBody: OutgoingContent) : OutgoingContent.ContentWrapper
Link copied to clipboard
class SSEConfig

A config for the SSE plugin.

Link copied to clipboard
interface SSESession : CoroutineScope

A Server-sent events session.

Properties

Link copied to clipboard
val SSE: ClientPlugin<SSEConfig>

Client Server-sent events plugin that allows you to establish an SSE connection to a server and receive Server-sent events from it.

Functions

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

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

Link copied to clipboard
fun HttpClientConfig<*>.SSE(config: SSEConfig.() -> Unit)

Installs the SSE plugin using the config as configuration.

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

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