Package io.netty.handler.codec.http.websocketx

Class WebSocketClientProtocolConfig.Builder

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketClientProtocolConfig.Builder

Enclosing class:

WebSocketClientProtocolConfig

public static final class WebSocketClientProtocolConfig.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WebSocketClientProtocolConfig.Builder	absoluteUpgradeUrl(boolean absoluteUpgradeUrl)	Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP
WebSocketClientProtocolConfig.Builder	allowExtensions(boolean allowExtensions)	Allow extensions to be used in the reserved bits of the web socket frame
WebSocketClientProtocolConfig.Builder	allowMaskMismatch(boolean allowMaskMismatch)	When set to true, frames which are not masked properly according to the standard will still be accepted.
WebSocketClientProtocolConfig	build()	Build unmodifiable client protocol configuration.
WebSocketClientProtocolConfig.Builder	customHeaders(HttpHeaders customHeaders)	Map of custom headers to add to the client request
WebSocketClientProtocolConfig.Builder	dropPongFrames(boolean dropPongFrames)	true if pong frames should not be forwarded
WebSocketClientProtocolConfig.Builder	forceCloseTimeoutMillis(long forceCloseTimeoutMillis)	Close the connection if it was not closed by the server after timeout specified
WebSocketClientProtocolConfig.Builder	generateOriginHeader(boolean generateOriginHeader)	Allows to generate the `Origin`|`Sec-WebSocket-Origin` header value for handshake request according the given webSocketURI.
WebSocketClientProtocolConfig.Builder	handleCloseFrames(boolean handleCloseFrames)	true if close frames should not be forwarded and just close the channel
WebSocketClientProtocolConfig.Builder	handshakeTimeoutMillis(long handshakeTimeoutMillis)	Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
WebSocketClientProtocolConfig.Builder	maxFramePayloadLength(int maxFramePayloadLength)	Maximum length of a frame's payload
WebSocketClientProtocolConfig.Builder	performMasking(boolean performMasking)	Whether to mask all written websocket frames.
WebSocketClientProtocolConfig.Builder	sendCloseFrame(WebSocketCloseStatus sendCloseFrame)	Close frame to send, when close frame was not send manually.
WebSocketClientProtocolConfig.Builder	subprotocol(String subprotocol)	Sub protocol request sent to the server.
WebSocketClientProtocolConfig.Builder	version(WebSocketVersion version)	Version of web socket specification to use to connect to the server
WebSocketClientProtocolConfig.Builder	webSocketUri(String webSocketUri)	URL for web socket communications. e.g "ws://myhost.com/mypath".
WebSocketClientProtocolConfig.Builder	webSocketUri(URI webSocketUri)	URL for web socket communications. e.g "ws://myhost.com/mypath".
WebSocketClientProtocolConfig.Builder	withUTF8Validator(boolean withUTF8Validator)	Toggles UTF8 validation for payload of text websocket frames.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

webSocketUri

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

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.

subprotocol

public WebSocketClientProtocolConfig.Builder subprotocol(String subprotocol)

Sub protocol request sent to the server.

version

public WebSocketClientProtocolConfig.Builder version(WebSocketVersion version)

Version of web socket specification to use to connect to the server

allowExtensions

public WebSocketClientProtocolConfig.Builder allowExtensions(boolean allowExtensions)

Allow extensions to be used in the reserved bits of the web socket frame

customHeaders

public WebSocketClientProtocolConfig.Builder customHeaders(HttpHeaders customHeaders)

Map of custom headers to add to the client request

maxFramePayloadLength

public WebSocketClientProtocolConfig.Builder maxFramePayloadLength(int maxFramePayloadLength)

Maximum length of a frame's payload

performMasking

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.

allowMaskMismatch

public WebSocketClientProtocolConfig.Builder allowMaskMismatch(boolean allowMaskMismatch)

When set to true, frames which are not masked properly according to the standard will still be accepted.

handleCloseFrames

public WebSocketClientProtocolConfig.Builder handleCloseFrames(boolean handleCloseFrames)

true if close frames should not be forwarded and just close the channel

sendCloseFrame

public WebSocketClientProtocolConfig.Builder sendCloseFrame(WebSocketCloseStatus sendCloseFrame)

Close frame to send, when close frame was not send manually. Or null to disable proper close.

dropPongFrames

public WebSocketClientProtocolConfig.Builder dropPongFrames(boolean dropPongFrames)

true if pong frames should not be forwarded

handshakeTimeoutMillis

public WebSocketClientProtocolConfig.Builder handshakeTimeoutMillis(long handshakeTimeoutMillis)

Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

forceCloseTimeoutMillis

public WebSocketClientProtocolConfig.Builder forceCloseTimeoutMillis(long forceCloseTimeoutMillis)

Close the connection if it was not closed by the server after timeout specified

absoluteUpgradeUrl

public WebSocketClientProtocolConfig.Builder absoluteUpgradeUrl(boolean absoluteUpgradeUrl)

Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP

generateOriginHeader

public WebSocketClientProtocolConfig.Builder generateOriginHeader(boolean generateOriginHeader)

Allows to generate the `Origin`|`Sec-WebSocket-Origin` header value for handshake request according the given webSocketURI. Usually it's not necessary and can be disabled, but for backward compatibility is set to true as default.

withUTF8Validator

public WebSocketClientProtocolConfig.Builder withUTF8Validator(boolean withUTF8Validator)

Toggles UTF8 validation for payload of text websocket frames. By default validation is enabled.

build

public WebSocketClientProtocolConfig build()

Build unmodifiable client protocol configuration.