Package io.quarkus.websockets.next

Interface WebSocketsServerRuntimeConfig

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

  • Method Details

    • supportedSubprotocols

      Optional<List<String>> supportedSubprotocols()
      See The WebSocket Protocol

    • perMessageCompressionSupported

      @WithDefault("true") boolean perMessageCompressionSupported()
      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 server sends a ping message to a connected client 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.

    • security

      WebSocketsServerRuntimeConfig.Security security()
      WebSockets-specific security configuration.

    • devMode

      WebSocketsServerRuntimeConfig.DevMode devMode()
      Dev mode configuration.

    • trafficLogging

      TrafficLoggingConfig trafficLogging()
      Traffic logging config.