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

Package io.ktor.http.cio.websocket

Functions

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, period: Duration, timeout: Duration, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Frame.Pong>

Launch pinger coroutine on CoroutineScope that is sending ping every specified period to outgoing channel, waiting for and verifying client's pong frames. It is also handling timeout and sending timeout close frame

WebSockets

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

Properties

pingInterval

var DefaultWebSocketServerSession.pingInterval: Duration?

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

pingInterval

val WebSockets.pingInterval: Duration?

pingPeriod

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

timeout

val WebSockets.timeout: Duration

timeout

var WebSockets.WebSocketOptions.timeout: Duration