io.ktor.client.plugins.websocket

interface ClientWebSocketSession : WebSocketSession

class DefaultClientWebSocketSession(val 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 plugin.

WebSockets

class WebSockets

Client WebSocket plugin.

receiveDeserialized

inline suspend fun <T> DefaultClientWebSocketSession.receiveDeserialized(): T

Dequeues a frame and deserializes it to the type T using WebSocket content converter. May throw an exception WebsocketDeserializeException if the converter can't deserialize frame data to type T. May throw WebsocketDeserializeException if the received frame type is not Frame.Text or Frame.Binary. In this case, WebsocketDeserializeException.frame contains the received frame. May throw ClosedReceiveChannelException if a channel was closed

sendSerialized

inline suspend fun <T> DefaultClientWebSocketSession.sendSerialized(data: T)

Serializes data to a frame and enqueues this frame. May suspend if the outgoing queue is full. If the outgoing channel is already closed, throws an exception, so it is impossible to transfer any message. Frames sent after a Close frame are silently ignored. Note that a Close frame could be sent automatically in reply to a peer's Close frame unless it is a raw WebSocket session.

webSocket

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? = null, port: Int? = null, path: String? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with DefaultClientWebSocketSession.

WebSockets

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

Installs the WebSockets plugin using the config as configuration.

webSocketSession

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

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

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

Opens a DefaultClientWebSocketSession.

ws

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? = null, port: Int? = null, path: String? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with DefaultClientWebSocketSession.

wss

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? = null, port: Int? = null, path: String? = null, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with secure DefaultClientWebSocketSession.

converter

val DefaultClientWebSocketSession.converter: WebsocketContentConverter?

Converter for web socket session

Package-level declarations

Types

Functions

Properties