ktor-websockets / io.ktor.http.cio.websocket

Package io.ktor.http.cio.websocket

Extensions for External Classes

kotlinx.coroutines.CoroutineScope

Properties

pingInterval

var DefaultWebSocketServerSession.pingInterval: Duration?

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

val WebSockets.pingInterval: Duration?

pingPeriod

var WebSocketOptions.pingPeriod: Duration?

timeout

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

val WebSockets.timeout: Duration
var WebSocketOptions.timeout: Duration

Functions

WebSockets

fun WebSockets(pingInterval: Duration?, timeout: Duration, maxFrameSize: Long, masking: Boolean): WebSockets