Class WebSocketClientProtocolConfig
- java.lang.Object
-
- io.netty.handler.codec.http.websocketx.WebSocketClientProtocolConfig
-
public final class WebSocketClientProtocolConfig extends java.lang.Object
WebSocket server configuration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebSocketClientProtocolConfig.Builder
-
Field Summary
Fields Modifier and Type Field Description private boolean
absoluteUpgradeUrl
private boolean
allowExtensions
private boolean
allowMaskMismatch
private HttpHeaders
customHeaders
(package private) static boolean
DEFAULT_ALLOW_MASK_MISMATCH
(package private) static boolean
DEFAULT_DROP_PONG_FRAMES
(package private) static boolean
DEFAULT_GENERATE_ORIGIN_HEADER
(package private) static boolean
DEFAULT_HANDLE_CLOSE_FRAMES
(package private) static boolean
DEFAULT_PERFORM_MASKING
(package private) static boolean
DEFAULT_WITH_UTF8_VALIDATOR
private boolean
dropPongFrames
private long
forceCloseTimeoutMillis
private boolean
generateOriginHeader
private boolean
handleCloseFrames
private long
handshakeTimeoutMillis
private int
maxFramePayloadLength
private boolean
performMasking
private WebSocketCloseStatus
sendCloseFrame
private java.lang.String
subprotocol
private WebSocketVersion
version
private java.net.URI
webSocketUri
private boolean
withUTF8Validator
-
Constructor Summary
Constructors Modifier Constructor Description private
WebSocketClientProtocolConfig(java.net.URI webSocketUri, java.lang.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 Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
absoluteUpgradeUrl()
boolean
allowExtensions()
boolean
allowMaskMismatch()
HttpHeaders
customHeaders()
boolean
dropPongFrames()
long
forceCloseTimeoutMillis()
boolean
generateOriginHeader()
boolean
handleCloseFrames()
long
handshakeTimeoutMillis()
int
maxFramePayloadLength()
static WebSocketClientProtocolConfig.Builder
newBuilder()
boolean
performMasking()
WebSocketCloseStatus
sendCloseFrame()
java.lang.String
subprotocol()
WebSocketClientProtocolConfig.Builder
toBuilder()
java.lang.String
toString()
WebSocketVersion
version()
java.net.URI
webSocketUri()
boolean
withUTF8Validator()
-
-
-
Field Detail
-
DEFAULT_PERFORM_MASKING
static final boolean DEFAULT_PERFORM_MASKING
- See Also:
- Constant Field Values
-
DEFAULT_ALLOW_MASK_MISMATCH
static final boolean DEFAULT_ALLOW_MASK_MISMATCH
- See Also:
- Constant Field Values
-
DEFAULT_HANDLE_CLOSE_FRAMES
static final boolean DEFAULT_HANDLE_CLOSE_FRAMES
- See Also:
- Constant Field Values
-
DEFAULT_DROP_PONG_FRAMES
static final boolean DEFAULT_DROP_PONG_FRAMES
- See Also:
- Constant Field Values
-
DEFAULT_GENERATE_ORIGIN_HEADER
static final boolean DEFAULT_GENERATE_ORIGIN_HEADER
- See Also:
- Constant Field Values
-
DEFAULT_WITH_UTF8_VALIDATOR
static final boolean DEFAULT_WITH_UTF8_VALIDATOR
- See Also:
- Constant Field Values
-
webSocketUri
private final java.net.URI webSocketUri
-
subprotocol
private final java.lang.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 Detail
-
WebSocketClientProtocolConfig
private WebSocketClientProtocolConfig(java.net.URI webSocketUri, java.lang.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 Detail
-
webSocketUri
public java.net.URI webSocketUri()
-
subprotocol
public java.lang.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 java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toBuilder
public WebSocketClientProtocolConfig.Builder toBuilder()
-
newBuilder
public static WebSocketClientProtocolConfig.Builder newBuilder()
-
-