WebSockets
WebSockets support plugin. It is required to be installed first before binding any websocket endpoints
install(WebSockets)
install(Routing) {
webSocket("/ws") {
incoming.consumeForEach { ... }
}
}
Content copied to clipboard
Parameters
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.
Constructors
Types
Link copied to clipboard
Plugin installation object.
Link copied to clipboard
class WebSocketOptions
Websockets configuration options
Properties
Link copied to clipboard
Link copied to clipboard