WebSockets

class WebSockets : CoroutineScope(source)

WebSockets support plugin. It is required to be installed first before binding any websocket endpoints

install(WebSockets)

install(Routing) {
    webSocket("/ws") {
         incoming.consumeForEach { ... }
    }
}

pingIntervalMillis

duration between pings or PINGER_DISABLED to disable pings.

timeoutMillis

write/ping timeout after that a connection will be closed.

maxFrameSize

maximum frame that could be received or sent.

masking

whether masking need to be enabled (useful for security).

extensionsConfig

is configuration for WebSocket extensions.

Constructors

constructor(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean)

object Plugin : BaseApplicationPlugin<Application, WebSockets.WebSocketOptions, WebSockets>

Plugin installation object.

Websockets configuration options

val contentConverter: WebsocketContentConverter?

val extensionsConfig: WebSocketExtensionsConfig