ktor-server-websockets/io.ktor.server.websocket/DefaultWebSocketServerSession

DefaultWebSocketServerSession

interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession

Represents a server-side web socket session with all default implementations

See also

DefaultWebSocketSession

Functions

abstract suspend fun flush()

open suspend fun send(frame: Frame)

abstract fun start(negotiatedExtensions: List<WebSocketExtension<*>>)

abstract fun ~~terminate~~()

Properties

abstract val call: ApplicationCall

Associated received call that originating this session

abstract val closeReason: Deferred<CloseReason?>

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val extensions: List<WebSocketExtension<*>>

abstract val incoming: ReceiveChannel<Frame>

abstract var masking: Boolean

abstract var maxFrameSize: Long

abstract val outgoing: SendChannel<Frame>

pingIntervalMillis

abstract var pingIntervalMillis: Long

abstract var timeoutMillis: Long

Extensions

val WebSocketServerSession.application: Application

An application that started this web socket session

val WebSocketServerSession.converter: WebsocketContentConverter?

Converter for web socket session

var DefaultWebSocketServerSession.pingInterval: Duration?

Ping interval or null to disable pinger. Please note that pongs will be handled despite this setting.

receiveDeserialized

inline suspend fun <T> WebSocketServerSession.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> WebSocketServerSession.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.

var DefaultWebSocketServerSession.timeout: Duration

A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if pingInterval is null (pinger is disabled).