Package io.quarkus.websockets.next

Interface WebSocketsClientRuntimeConfig

@ConfigMapping(prefix="quarkus.websockets-next.client") @ConfigRoot(phase=RUN_TIME) public interface WebSocketsClientRuntimeConfig

  • Method Details

    • offerPerMessageCompression

      @WithDefault("false") boolean offerPerMessageCompression()
      Compression Extensions for WebSocket are supported by default.

      See also RFC 7692

    • compressionLevel

      OptionalInt compressionLevel()
      The compression level must be a value between 0 and 9. The default value is 6.

    • maxMessageSize

      OptionalInt maxMessageSize()
      The maximum size of a message in bytes. The default values is 262144.

    • autoPingInterval

      Optional<Duration> autoPingInterval()
      The interval after which, when set, the client sends a ping message to a connected server automatically.

      Ping messages are not sent automatically by default.

    • unhandledFailureStrategy

      @WithDefault("close") UnhandledFailureStrategy unhandledFailureStrategy()
      The strategy used when an error occurs but no error handler can handle the failure.

      By default, the connection is closed when an unhandled failure occurs.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

      The default TLS configuration is not used by default.

    • trafficLogging

      TrafficLoggingConfig trafficLogging()
      Traffic logging config.