WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean)
WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean, extensionsConfig: WebSocketExtensionsConfig)
WebSockets support feature. 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 null
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.