ktor-client-core/io.ktor.client.features.websocket

Package io.ktor.client.features.websocket

Types

ClientWebSocketSession

interface ClientWebSocketSession : WebSocketSession

Client specific WebSocketSession.

DefaultClientWebSocketSession

class DefaultClientWebSocketSession(call: HttpClientCall, delegate: DefaultWebSocketSession) : ClientWebSocketSession, DefaultWebSocketSession

ClientSpecific DefaultWebSocketSession.

WebSocketCapability

object WebSocketCapability : HttpClientEngineCapability<Unit>

Indicates if a client engine supports WebSockets.

WebSocketException

class WebSocketException(message: String) : IllegalStateException

WebSocketExtensionsCapability

object WebSocketExtensionsCapability : HttpClientEngineCapability<Unit>

Indicates if a client engine supports extensions for WebSocket feature.

class WebSockets

Client WebSocket feature.

Functions

suspend fun HttpClient.webSocket(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.webSocket(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.webSocket(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Open block with DefaultClientWebSocketSession.

fun HttpClientConfig<*>.WebSockets(config: WebSockets.Config.() -> Unit)

Install WebSockets feature using the config as configuration.

webSocketSession

suspend fun HttpClient.webSocketSession(block: HttpRequestBuilder.() -> Unit): DefaultClientWebSocketSession

suspend fun HttpClient.webSocketSession(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", block: HttpRequestBuilder.() -> Unit = {}): DefaultClientWebSocketSession

Open DefaultClientWebSocketSession.

suspend fun HttpClient.ws(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.ws(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.ws(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Open block with DefaultClientWebSocketSession.

suspend fun HttpClient.wss(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.wss(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

suspend fun HttpClient.wss(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Open block with secure DefaultClientWebSocketSession.