ktor-client-core/io.ktor.client.plugins.websocket/DefaultClientWebSocketSession

DefaultClientWebSocketSession

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

ClientSpecific DefaultWebSocketSession.

Constructors

DefaultClientWebSocketSession

fun DefaultClientWebSocketSession(call: HttpClientCall, delegate: DefaultWebSocketSession)

Functions

open suspend override fun flush()

open suspend override fun send(frame: Frame)

open override fun start(negotiatedExtensions: List<WebSocketExtension<*>>)

open override fun ~~terminate~~()

Properties

open override val call: HttpClientCall

HttpClientCall associated with session.

open override val closeReason: Deferred<CloseReason?>

coroutineContext

open override val coroutineContext: CoroutineContext

open override val extensions: List<WebSocketExtension<*>>

open override val incoming: ReceiveChannel<Frame>

open override var masking: Boolean

open override var maxFrameSize: Long

open override val outgoing: SendChannel<Frame>

pingIntervalMillis

open override var pingIntervalMillis: Long

open override var timeoutMillis: Long

Extensions

val DefaultClientWebSocketSession.converter: WebsocketContentConverter?

Converter for web socket session

mapEngineExceptions

fun CoroutineScope.mapEngineExceptions(input: ByteReadChannel, request: HttpRequestData): ByteReadChannel

Returns ByteReadChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException.

fun CoroutineScope.mapEngineExceptions(output: ByteWriteChannel, request: HttpRequestData): ByteWriteChannel

Returns ByteWriteChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException.

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

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.