Record: CommonClientConfiguration

Common client configurations for WebSocket clients.

Closed record


  • subProtocols string[ ](default [])
  • Negotiable sub protocols of the client

  • customHeaders map<string>(default {})
  • Custom headers, which should be sent to the server

  • readTimeout decimal(default -1)
  • Read timeout (in seconds) of the client

  • writeTimeout decimal(default -1)
  • Write timeout (in seconds) of the client

  • secureSocket ClientSecureSocket?(default ())
  • SSL/TLS-related options

  • maxFrameSize int(default 65536)
  • The maximum payload size of a WebSocket frame in bytes. If this is not set, is negative, or is zero, the default frame size of 65536 will be used

  • webSocketCompressionEnabled boolean(default true)
  • Enable support for compression in the WebSocket

  • handShakeTimeout decimal(default 300)
  • Time (in seconds) that a connection waits to get the response of the WebSocket handshake. If the timeout exceeds, then the connection is terminated with an error. If the value < 0, then the value sets to the default value(300)

  • cookies Cookie[ ]?
  • An Array of http:Cookie

  • auth ClientAuthConfig?
  • Configurations related to client authentication

  • pingPongHandler PingPongService?
  • A service to handle the ping/pong frames. Resources in this service gets called on the receipt of ping/pong frames from the server

  • retryConfig WebSocketRetryConfig?(default ())
  • Retry related configurations.