ktor-client-core/io.ktor.client.plugins.websocket/WebSockets/Config

Config

class Config(source)

WebSockets configuration.

Report a problem

Constructors

constructor()

Properties

contentConverter

var contentConverter: WebsocketContentConverter?

A converter for serialization/deserialization

var maxFrameSize: Long

Sets maximum frame size in bytes.

var WebSockets.Config.pingInterval: Duration?

Sets interval of sending FrameType.PING messages.

pingIntervalMillis

var pingIntervalMillis: Long

Sets interval of sending ping frames.

Functions

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

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.

fun extensions(block: WebSocketExtensionsConfig.() -> Unit)

Configure WebSocket extensions.