Top Description Inners Fields Constructors Methods

io.netty5.handler.codec.http.websocketx

public final Class WebSocketClientProtocolConfig

Class Inheritance

extends Object

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

Imports

io.netty5.handler.codec.http.headers.HttpHeaders, java.net.URI, java.util.Objects

WebSocket server configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebSocketClientProtocolConfig.Builder

Field Summary

Modifier and Type	Field and Description
private final boolean	absoluteUpgradeUrl
private final boolean	allowExtensions
private final boolean	allowMaskMismatch
private final HttpHeaders	customHeaders
pack-priv static final boolean	DEFAULT_ALLOW_MASK_MISMATCH
pack-priv static final boolean	DEFAULT_DROP_PONG_FRAMES
pack-priv static final boolean	DEFAULT_HANDLE_CLOSE_FRAMES
pack-priv static final boolean	DEFAULT_PERFORM_MASKING
private final boolean	dropPongFrames
private final long	forceCloseTimeoutMillis
private final boolean	handleCloseFrames
private final long	handshakeTimeoutMillis
private final int	maxFramePayloadLength
private final boolean	performMasking
private final WebSocketCloseStatus	sendCloseFrame
private final String	subprotocol
private final WebSocketVersion	version
private final URI	webSocketUri

Constructor Summary

Access	Constructor and Description
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)

Method Summary

Modifier and Type	Method and Description
public boolean	absoluteUpgradeUrl()
public boolean	allowExtensions()
public boolean	allowMaskMismatch()
public HttpHeaders	customHeaders()
public boolean	dropPongFrames()
public long	forceCloseTimeoutMillis()
public boolean	handleCloseFrames()
public long	handshakeTimeoutMillis()
public int	maxFramePayloadLength()
public static WebSocketClientProtocolConfig.Builder	newBuilder()
public boolean	performMasking()
public WebSocketCloseStatus	sendCloseFrame()
public String	subprotocol()
public WebSocketClientProtocolConfig.Builder	toBuilder()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public WebSocketVersion	version()
public URI	webSocketUri()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

absoluteUpgradeUrl	back to summary
private final boolean absoluteUpgradeUrl

allowExtensions	back to summary
private final boolean allowExtensions

allowMaskMismatch	back to summary
private final boolean allowMaskMismatch

customHeaders	back to summary
private final HttpHeaders customHeaders

DEFAULT_ALLOW_MASK_MISMATCH	back to summary
pack-priv static final boolean DEFAULT_ALLOW_MASK_MISMATCH

DEFAULT_DROP_PONG_FRAMES	back to summary
pack-priv static final boolean DEFAULT_DROP_PONG_FRAMES

DEFAULT_HANDLE_CLOSE_FRAMES	back to summary
pack-priv static final boolean DEFAULT_HANDLE_CLOSE_FRAMES

DEFAULT_PERFORM_MASKING	back to summary
pack-priv static final boolean DEFAULT_PERFORM_MASKING

dropPongFrames	back to summary
private final boolean dropPongFrames

forceCloseTimeoutMillis	back to summary
private final long forceCloseTimeoutMillis

handleCloseFrames	back to summary
private final boolean handleCloseFrames

handshakeTimeoutMillis	back to summary
private final long handshakeTimeoutMillis

maxFramePayloadLength	back to summary
private final int maxFramePayloadLength

performMasking	back to summary
private final boolean performMasking

sendCloseFrame	back to summary
private final WebSocketCloseStatus sendCloseFrame

subprotocol	back to summary
private final String subprotocol

version	back to summary
private final WebSocketVersion version

webSocketUri	back to summary
private final URI webSocketUri

Constructor Detail

WebSocketClientProtocolConfig

back to summary

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)

Method Detail

absoluteUpgradeUrl	back to summary
public boolean absoluteUpgradeUrl()

allowExtensions	back to summary
public boolean allowExtensions()

allowMaskMismatch	back to summary
public boolean allowMaskMismatch()

customHeaders	back to summary
public HttpHeaders customHeaders()

dropPongFrames	back to summary
public boolean dropPongFrames()

forceCloseTimeoutMillis	back to summary
public long forceCloseTimeoutMillis()

handleCloseFrames	back to summary
public boolean handleCloseFrames()

handshakeTimeoutMillis	back to summary
public long handshakeTimeoutMillis()

maxFramePayloadLength	back to summary
public int maxFramePayloadLength()

newBuilder	back to summary
public static WebSocketClientProtocolConfig.Builder newBuilder()

performMasking	back to summary
public boolean performMasking()

sendCloseFrame	back to summary
public WebSocketCloseStatus sendCloseFrame()

subprotocol	back to summary
public String subprotocol()

toBuilder	back to summary
public WebSocketClientProtocolConfig.Builder toBuilder()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

version	back to summary
public WebSocketVersion version()

webSocketUri	back to summary
public URI webSocketUri()

io.netty5.handler.codec.http.websocketx back to summary

public final Class WebSocketClientProtocolConfig.Builder

Class Inheritance

extends Object

java.lang.Object
io.netty5.handler.codec.http.websocketx.WebSocketClientProtocolConfig.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	absoluteUpgradeUrl
private boolean	allowExtensions
private boolean	allowMaskMismatch
private HttpHeaders	customHeaders
private boolean	dropPongFrames
private long	forceCloseTimeoutMillis
private boolean	handleCloseFrames
private long	handshakeTimeoutMillis
private int	maxFramePayloadLength
private boolean	performMasking
private WebSocketCloseStatus	sendCloseFrame
private String	subprotocol
private WebSocketVersion	version
private URI	webSocketUri

Constructor Summary

Access	Constructor and Description
private	Builder(WebSocketClientProtocolConfig clientConfig)
private	Builder(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)

Method Summary

Modifier and Type	Method and Description
public WebSocketClientProtocolConfig.Builder	absoluteUpgradeUrl(boolean absoluteUpgradeUrl) Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP
public WebSocketClientProtocolConfig.Builder	allowExtensions(boolean allowExtensions) Allow extensions to be used in the reserved bits of the web socket frame
public WebSocketClientProtocolConfig.Builder	allowMaskMismatch(boolean allowMaskMismatch) When set to true, frames which are not masked properly according to the standard will still be accepted.
public WebSocketClientProtocolConfig	build() Build unmodifiable client protocol configuration.
public WebSocketClientProtocolConfig.Builder	customHeaders(HttpHeaders customHeaders) Map of custom headers to add to the client request
public WebSocketClientProtocolConfig.Builder	dropPongFrames(boolean dropPongFrames) `true` if pong frames should not be forwarded
public WebSocketClientProtocolConfig.Builder	forceCloseTimeoutMillis(long forceCloseTimeoutMillis) Close the connection if it was not closed by the server after timeout specified
public WebSocketClientProtocolConfig.Builder	handleCloseFrames(boolean handleCloseFrames) `true` if close frames should not be forwarded and just close the channel
public WebSocketClientProtocolConfig.Builder	handshakeTimeoutMillis(long handshakeTimeoutMillis) Handshake timeout in millis, when handshake timeout, will trigger an inbound channel event `WebSocketClientHandshakeCompletionEvent` with a `WebSocketHandshakeException`.
public WebSocketClientProtocolConfig.Builder	maxFramePayloadLength(int maxFramePayloadLength) Maximum length of a frame's payload
public WebSocketClientProtocolConfig.Builder	performMasking(boolean performMasking) Whether to mask all written websocket frames.
public WebSocketClientProtocolConfig.Builder	sendCloseFrame(WebSocketCloseStatus sendCloseFrame) Close frame to send, when close frame was not send manually.
public WebSocketClientProtocolConfig.Builder	subprotocol(String subprotocol) Sub protocol request sent to the server.
public WebSocketClientProtocolConfig.Builder	version(WebSocketVersion version) Version of web socket specification to use to connect to the server
public WebSocketClientProtocolConfig.Builder	webSocketUri(String webSocketUri) URL for web socket communications.
public WebSocketClientProtocolConfig.Builder	webSocketUri(URI webSocketUri) URL for web socket communications.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

absoluteUpgradeUrl	back to summary
private boolean absoluteUpgradeUrl

allowExtensions	back to summary
private boolean allowExtensions

allowMaskMismatch	back to summary
private boolean allowMaskMismatch

customHeaders	back to summary
private HttpHeaders customHeaders

dropPongFrames	back to summary
private boolean dropPongFrames

forceCloseTimeoutMillis	back to summary
private long forceCloseTimeoutMillis

handleCloseFrames	back to summary
private boolean handleCloseFrames

handshakeTimeoutMillis	back to summary
private long handshakeTimeoutMillis

maxFramePayloadLength	back to summary
private int maxFramePayloadLength

performMasking	back to summary
private boolean performMasking

sendCloseFrame	back to summary
private WebSocketCloseStatus sendCloseFrame

subprotocol	back to summary
private String subprotocol

version	back to summary
private WebSocketVersion version

webSocketUri	back to summary
private URI webSocketUri

Constructor Detail

Builder	back to summary
private Builder(WebSocketClientProtocolConfig clientConfig)

Builder	back to summary
private Builder(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)

Method Detail

absoluteUpgradeUrl	back to summary
public WebSocketClientProtocolConfig.Builder absoluteUpgradeUrl(boolean absoluteUpgradeUrl) Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP

allowExtensions	back to summary
public WebSocketClientProtocolConfig.Builder allowExtensions(boolean allowExtensions) Allow extensions to be used in the reserved bits of the web socket frame

allowMaskMismatch	back to summary
public WebSocketClientProtocolConfig.Builder allowMaskMismatch(boolean allowMaskMismatch) When set to true, frames which are not masked properly according to the standard will still be accepted.

build	back to summary
public WebSocketClientProtocolConfig build() Build unmodifiable client protocol configuration.

customHeaders	back to summary
public WebSocketClientProtocolConfig.Builder customHeaders(HttpHeaders customHeaders) Map of custom headers to add to the client request

dropPongFrames	back to summary
public WebSocketClientProtocolConfig.Builder dropPongFrames(boolean dropPongFrames) `true` if pong frames should not be forwarded

forceCloseTimeoutMillis	back to summary
public WebSocketClientProtocolConfig.Builder forceCloseTimeoutMillis(long forceCloseTimeoutMillis) Close the connection if it was not closed by the server after timeout specified

handleCloseFrames	back to summary
public WebSocketClientProtocolConfig.Builder handleCloseFrames(boolean handleCloseFrames) `true` if close frames should not be forwarded and just close the channel

handshakeTimeoutMillis	back to summary
public WebSocketClientProtocolConfig.Builder handshakeTimeoutMillis(long handshakeTimeoutMillis) Handshake timeout in millis, when handshake timeout, will trigger an inbound channel event `WebSocketClientHandshakeCompletionEvent` with a `WebSocketHandshakeException`.

maxFramePayloadLength	back to summary
public WebSocketClientProtocolConfig.Builder maxFramePayloadLength(int maxFramePayloadLength) Maximum length of a frame's payload

performMasking	back to summary
public WebSocketClientProtocolConfig.Builder performMasking(boolean performMasking) Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

sendCloseFrame	back to summary
public WebSocketClientProtocolConfig.Builder sendCloseFrame(WebSocketCloseStatus sendCloseFrame) Close frame to send, when close frame was not send manually. Or `null` to disable proper close.

subprotocol	back to summary
public WebSocketClientProtocolConfig.Builder subprotocol(String subprotocol) Sub protocol request sent to the server.

version	back to summary
public WebSocketClientProtocolConfig.Builder version(WebSocketVersion version) Version of web socket specification to use to connect to the server

webSocketUri	back to summary
public WebSocketClientProtocolConfig.Builder webSocketUri(String webSocketUri) URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

webSocketUri	back to summary
public WebSocketClientProtocolConfig.Builder webSocketUri(URI webSocketUri) URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.