ktor-websockets/io.ktor.websocket/DefaultWebSocketServerSession

DefaultWebSocketServerSession

interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession

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

See also

io.ktor.http.cio.websocket.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

var DefaultWebSocketServerSession.pingInterval: Duration?

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

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).