| Package | Description |
|---|---|
| org.apache.hc.client5.http.websocket.api |
Public WebSocket API for client applications.
|
| Modifier and Type | Method and Description |
|---|---|
static WebSocketClientConfig.Builder |
WebSocketClientConfig.custom()
Creates a new builder instance with default settings.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.enableHttp2(boolean enabled)
Enables HTTP/2 Extended CONNECT (RFC 8441) for supported endpoints.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.enablePerMessageDeflate(boolean v)
Enables or disables offering
permessage-deflate during the handshake. |
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.offerClientNoContextTakeover(boolean v)
Offers
client_no_context_takeover in the PMCE offer. |
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.offerServerMaxWindowBits(Integer v)
Offers
server_max_window_bits in the PMCE offer. |
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.offerServerNoContextTakeover(boolean v)
Offers
server_no_context_takeover in the PMCE offer. |
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setAutoPong(boolean v)
Enables or disables automatic PONG replies for received PING frames.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setCloseWaitTimeout(Timeout v)
Sets the close handshake wait timeout.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setConnectTimeout(Timeout v)
Sets the timeout used to establish the initial TCP/TLS connection.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setDirectBuffers(boolean v)
Enables or disables the use of direct buffers for internal I/O.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setMaxFrameSize(int v)
Sets the maximum accepted frame payload size.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setMaxFramesPerTick(int v)
Sets the limit of frames written per reactor tick.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setMaxMessageSize(long v)
Sets the maximum accepted message size.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setMaxOutboundControlQueue(int v)
Sets the maximum number of queued outbound control frames.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setMaxOutboundDataBytes(long v)
Sets the maximum number of bytes that can be queued for outbound data frames.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setOutgoingChunkSize(int v)
Sets the preferred outgoing fragmentation chunk size.
|
WebSocketClientConfig.Builder |
WebSocketClientConfig.Builder.setSubprotocols(List<String> v)
Sets the ordered list of subprotocols offered to the server.
|
Copyright © 1999–2021 The Apache Software Foundation. All rights reserved.