Package | Description |
---|---|
io.netty.handler.codec.http.websocketx |
Encoder, decoder, handshakers and their related message types for
Web Socket data frames.
|
Modifier and Type | Method and Description |
---|---|
WebSocketClientProtocolConfig.Builder |
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 |
WebSocketClientProtocolConfig.Builder.allowExtensions(boolean allowExtensions)
Allow extensions to be used in the reserved bits of the web socket frame
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.allowMaskMismatch(boolean allowMaskMismatch)
When set to true, frames which are not masked properly according to the standard will still be accepted.
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.customHeaders(HttpHeaders customHeaders)
Map of custom headers to add to the client request
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.dropPongFrames(boolean dropPongFrames)
true if pong frames should not be forwarded |
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.forceCloseTimeoutMillis(long forceCloseTimeoutMillis)
Close the connection if it was not closed by the server after timeout specified
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.generateOriginHeader(boolean generateOriginHeader)
Allows to generate the `Origin`|`Sec-WebSocket-Origin` header value for handshake request
according the given webSocketURI.
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.handleCloseFrames(boolean handleCloseFrames)
true if close frames should not be forwarded and just close the channel |
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.handshakeTimeoutMillis(long handshakeTimeoutMillis)
Handshake timeout in mills, when handshake timeout, will trigger user
event
WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT |
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.maxFramePayloadLength(int maxFramePayloadLength)
Maximum length of a frame's payload
|
static WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.newBuilder() |
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.performMasking(boolean performMasking)
Whether to mask all written websocket frames.
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.sendCloseFrame(WebSocketCloseStatus sendCloseFrame)
Close frame to send, when close frame was not send manually.
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.subprotocol(String subprotocol)
Sub protocol request sent to the server.
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.toBuilder() |
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.version(WebSocketVersion version)
Version of web socket specification to use to connect to the server
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.webSocketUri(String webSocketUri)
URL for web socket communications. e.g "ws://myhost.com/mypath".
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.webSocketUri(URI webSocketUri)
URL for web socket communications. e.g "ws://myhost.com/mypath".
|
WebSocketClientProtocolConfig.Builder |
WebSocketClientProtocolConfig.Builder.withUTF8Validator(boolean withUTF8Validator)
Toggles UTF8 validation for payload of text websocket frames.
|
Copyright © 2008–2024 The Netty Project. All rights reserved.