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

WebSocketOptions

class WebSocketOptions

Websockets configuration options

Constructors

WebSocketOptions

constructor()

Properties

contentConverter

var contentConverter: WebsocketContentConverter?

A converter for serialization/deserialization

var masking: Boolean

Whether masking need to be enabled (useful for security)

var maxFrameSize: Long

Maximum frame that could be received or sent

var WebSockets.WebSocketOptions.pingPeriod: Duration?

pingPeriodMillis

var pingPeriodMillis: Long

Duration between pings or PINGER_DISABLED to disable pings

var WebSockets.WebSocketOptions.timeout: Duration

var timeoutMillis: Long

write/ping timeout after that a connection will be closed

Functions

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

Configure WebSocket extensions.