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

channels

fun channels(block: WebSocketChannelsConfig.() -> Unit)(source)

Configuration for the incoming and outgoing Frame queues. Both queues are unlimited by default, which may lead to OutOfMemoryError under high backpressure. Some engines don't support suspending limited-size incoming channels — check compatibility before using them.

Caution: A bounded incoming channel with ChannelOverflow.CLOSE will close on overflow, possibly causing exceptions for any frames received afterward.

channels {
    incoming = unlimited()
    outgoing = bounded(capacity = 512, onOverflow = ChannelOverflow.SUSPEND)
}

Report a problem