Record - http : WebSocketClientConfiguration

Configuration for the WebSocket client endpoint.


  • callbackService service ()
  • The callback service for the client. Resources in this service gets called on receipt of messages from the server.

  • subProtocols string []
  • Negotiable sub protocols for the client

  • customHeaders map {}
  • Custom headers which should be sent to the server

  • idleTimeoutInSeconds int -1
  • Idle timeout of the client. Upon timeout, onIdleTimeout resource (if defined) in the client service will be triggered.

  • readyOnConnect boolean true
  • true if the client is ready to receive messages as soon as the connection is established. This is true by default. If changed to false the function ready() of the WebSocketClientneeds to be called once to start receiving messages.

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

  • webSocketCompressionEnabled boolean true
  • Enable support for compression in WebSocket