ktor-websockets/io.ktor.websocket/WebSockets/WebSocketOptions

WebSocketOptions

class WebSocketOptions

Websockets configuration options

Constructors

WebSocketOptions

fun WebSocketOptions()

Functions

fun extensions(block: WebSocketExtensionsConfig.() -> Unit)

Configure WebSocket extensions.

Properties

var masking: Boolean = false

Whether masking need to be enabled (useful for security)

var maxFrameSize: Long

Maximum frame that could be received or sent

~~var~~ ~~pingPeriod~~: Duration?

Duration between pings or null to disable pings

pingPeriodMillis

var pingPeriodMillis: Long = 0

Duration between pings or 0 to disable pings

~~var~~ ~~timeout~~: Duration

write/ping timeout after that a connection will be closed

var timeoutMillis: Long = 15000

write/ping timeout after that a connection will be closed

Extensions

var WebSockets.WebSocketOptions.pingPeriod: Duration?

var WebSockets.WebSocketOptions.timeout: Duration