WebSocketOptions

class WebSocketOptions

Websockets configuration options

Constructors

Link copied to clipboard
fun WebSocketOptions()

Functions

Link copied to clipboard
fun extensions(block: <ERROR CLASS>.() -> Unit)

Configure WebSocket extensions.

Properties

Link copied to clipboard
var contentConverter: <ERROR CLASS>? = null

A converter for serialization/deserialization

Link copied to clipboard
var masking: Boolean = false

Whether masking need to be enabled (useful for security)

Link copied to clipboard
var maxFrameSize: Long

Maximum frame that could be received or sent

Link copied to clipboard
var pingPeriodMillis: Long = 0

Duration between pings or 0 to disable pings

Link copied to clipboard
var timeoutMillis: Long = 15000

write/ping timeout after that a connection will be closed

Extensions

Link copied to clipboard
var WebSockets.WebSocketOptions.pingPeriod: Duration?
Link copied to clipboard
var WebSockets.WebSocketOptions.timeout: Duration