Class WebSocketClientProtocolConfig

java.lang.Object
io.netty.handler.codec.http.websocketx.WebSocketClientProtocolConfig

public final class WebSocketClientProtocolConfig extends Object
WebSocket server configuration.
  • Field Details

    • DEFAULT_PERFORM_MASKING

      static final boolean DEFAULT_PERFORM_MASKING
      See Also:
    • DEFAULT_ALLOW_MASK_MISMATCH

      static final boolean DEFAULT_ALLOW_MASK_MISMATCH
      See Also:
    • DEFAULT_HANDLE_CLOSE_FRAMES

      static final boolean DEFAULT_HANDLE_CLOSE_FRAMES
      See Also:
    • DEFAULT_DROP_PONG_FRAMES

      static final boolean DEFAULT_DROP_PONG_FRAMES
      See Also:
    • DEFAULT_GENERATE_ORIGIN_HEADER

      static final boolean DEFAULT_GENERATE_ORIGIN_HEADER
      See Also:
    • DEFAULT_WITH_UTF8_VALIDATOR

      static final boolean DEFAULT_WITH_UTF8_VALIDATOR
      See Also:
    • webSocketUri

      private final URI webSocketUri
    • subprotocol

      private final String subprotocol
    • version

      private final WebSocketVersion version
    • allowExtensions

      private final boolean allowExtensions
    • customHeaders

      private final HttpHeaders customHeaders
    • maxFramePayloadLength

      private final int maxFramePayloadLength
    • performMasking

      private final boolean performMasking
    • allowMaskMismatch

      private final boolean allowMaskMismatch
    • handleCloseFrames

      private final boolean handleCloseFrames
    • sendCloseFrame

      private final WebSocketCloseStatus sendCloseFrame
    • dropPongFrames

      private final boolean dropPongFrames
    • handshakeTimeoutMillis

      private final long handshakeTimeoutMillis
    • forceCloseTimeoutMillis

      private final long forceCloseTimeoutMillis
    • absoluteUpgradeUrl

      private final boolean absoluteUpgradeUrl
    • generateOriginHeader

      private final boolean generateOriginHeader
    • withUTF8Validator

      private final boolean withUTF8Validator
  • Constructor Details

    • WebSocketClientProtocolConfig

      private WebSocketClientProtocolConfig(URI webSocketUri, String subprotocol, WebSocketVersion version, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean performMasking, boolean allowMaskMismatch, boolean handleCloseFrames, WebSocketCloseStatus sendCloseFrame, boolean dropPongFrames, long handshakeTimeoutMillis, long forceCloseTimeoutMillis, boolean absoluteUpgradeUrl, boolean generateOriginHeader, boolean withUTF8Validator)
  • Method Details

    • webSocketUri

      public URI webSocketUri()
    • subprotocol

      public String subprotocol()
    • version

      public WebSocketVersion version()
    • allowExtensions

      public boolean allowExtensions()
    • customHeaders

      public HttpHeaders customHeaders()
    • maxFramePayloadLength

      public int maxFramePayloadLength()
    • performMasking

      public boolean performMasking()
    • allowMaskMismatch

      public boolean allowMaskMismatch()
    • handleCloseFrames

      public boolean handleCloseFrames()
    • sendCloseFrame

      public WebSocketCloseStatus sendCloseFrame()
    • dropPongFrames

      public boolean dropPongFrames()
    • handshakeTimeoutMillis

      public long handshakeTimeoutMillis()
    • forceCloseTimeoutMillis

      public long forceCloseTimeoutMillis()
    • absoluteUpgradeUrl

      public boolean absoluteUpgradeUrl()
    • generateOriginHeader

      public boolean generateOriginHeader()
    • withUTF8Validator

      public boolean withUTF8Validator()
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • toBuilder

    • newBuilder

      public static WebSocketClientProtocolConfig.Builder newBuilder()