WebSocketClientConfig (Apache HttpClient WebSocket 5.7-alpha1 API)

java.lang.Object
- org.apache.hc.client5.http.websocket.api.WebSocketClientConfig

```
public final class WebSocketClientConfig
extends Object
```
Immutable configuration for WebSocket clients.
Instances are normally created via the associated builder. The configuration controls timeouts, maximum frame and message sizes, fragmentation behaviour and optional automatic responses to PING frames.

Unless explicitly overridden, reasonable defaults are selected for desktop and server environments. For mobile or memory-constrained deployments, consider adjusting buffer sizes and queue limits.

Since:

5.7

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WebSocketClientConfig.Builder
Builder for WebSocketClientConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebSocketClientConfig.Builder` Builder for `WebSocketClientConfig`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WebSocketClientConfig.Builder`	`custom()` Creates a new builder instance with default settings.
`Timeout`	`getCloseWaitTimeout()` Socket timeout used while waiting for the peer to complete the close handshake.
`Timeout`	`getConnectTimeout()` Timeout used for establishing the initial TCP/TLS connection.
`int`	`getMaxFrameSize()` Maximum accepted WebSocket frame payload size.
`int`	`getMaxFramesPerTick()` Limit of frames written per reactor "tick".
`long`	`getMaxMessageSize()` Maximum accepted message size after fragment reassembly (and after decompression if enabled).
`int`	`getMaxOutboundControlQueue()` Maximum number of queued outbound control frames.
`long`	`getMaxOutboundDataBytes()` Upper bound for the total number of bytes queued for outbound data frames.
`Integer`	`getOfferServerMaxWindowBits()` Optional value for `server_max_window_bits` in the PMCE offer.
`int`	`getOutgoingChunkSize()` Preferred outgoing fragmentation chunk size.
`List<String>`	`getSubprotocols()` Ordered list of WebSocket subprotocols offered to the server via `Sec-WebSocket-Protocol`.
`boolean`	`isAutoPong()` Whether the client automatically responds to PING frames with a PONG frame.
`boolean`	`isDirectBuffers()` Whether direct byte buffers are preferred for internal I/O.
`boolean`	`isHttp2Enabled()` Returns `true` if HTTP/2 Extended CONNECT (RFC 8441) is enabled.
`boolean`	`isOfferClientNoContextTakeover()` Whether the client offers the `client_no_context_takeover` PMCE parameter.
`boolean`	`isOfferServerNoContextTakeover()` Whether the client offers the `server_no_context_takeover` PMCE parameter.
`boolean`	`isPerMessageDeflateEnabled()` Whether the client offers the `permessage-deflate` extension during the handshake.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getConnectTimeout
```
public Timeout getConnectTimeout()
```
    Timeout used for establishing the initial TCP/TLS connection.
    
    Returns:
    
    connection timeout, may be null if the caller wants to rely on defaults
    
    Since:
    
    5.7
  - getSubprotocols
```
public List<String> getSubprotocols()
```
    Ordered list of WebSocket subprotocols offered to the server via Sec-WebSocket-Protocol.
    The server may select at most one. The client should treat a server-selected protocol that was not offered as a handshake failure.
    
    Returns:
    
    immutable list of offered subprotocols (never null)
    
    Since:
    
    5.7
  - isPerMessageDeflateEnabled
```
public boolean isPerMessageDeflateEnabled()
```
    Whether the client offers the permessage-deflate extension during the handshake.
    
    Returns:
    
    true if PMCE is offered, false otherwise
    
    Since:
    
    5.7
  - isOfferServerNoContextTakeover
```
public boolean isOfferServerNoContextTakeover()
```
    Whether the client offers the server_no_context_takeover PMCE parameter.
    
    Returns:
    
    true if the parameter is included in the offer
    
    Since:
    
    5.7
  - isOfferClientNoContextTakeover
```
public boolean isOfferClientNoContextTakeover()
```
    Whether the client offers the client_no_context_takeover PMCE parameter.
    
    Returns:
    
    true if the parameter is included in the offer
    
    Since:
    
    5.7
  - getOfferServerMaxWindowBits
```
public Integer getOfferServerMaxWindowBits()
```
    Optional value for server_max_window_bits in the PMCE offer.
    Valid values are in range 8..15 when non-null. This value limits the server's compressor; the client decoder can accept any 8..15 value.
    
    Returns:
    
    offered server_max_window_bits, or null if not offered
    
    Since:
    
    5.7
  - getMaxFrameSize
```
public int getMaxFrameSize()
```
    Maximum accepted WebSocket frame payload size.
    If an incoming frame exceeds this limit, the implementation should treat it as a protocol violation and initiate a close with an appropriate close code.
    
    Returns:
    
    maximum frame payload size in bytes (must be > 0)
    
    Since:
    
    5.7
  - getOutgoingChunkSize
```
public int getOutgoingChunkSize()
```
    Preferred outgoing fragmentation chunk size.
    Outgoing messages larger than this value may be fragmented into multiple frames.
    
    Returns:
    
    outgoing chunk size in bytes (must be > 0)
    
    Since:
    
    5.7
  - getMaxFramesPerTick
```
public int getMaxFramesPerTick()
```
    Limit of frames written per reactor "tick".
    This is a fairness control to reduce the risk of starving the reactor thread when a large backlog exists.
    
    Returns:
    
    maximum frames per tick (must be > 0)
    
    Since:
    
    5.7
  - isDirectBuffers
```
public boolean isDirectBuffers()
```
    Whether direct byte buffers are preferred for internal I/O.
    
    Returns:
    
    true for direct buffers, false for heap buffers
    
    Since:
    
    5.7
  - isAutoPong
```
public boolean isAutoPong()
```
    Whether the client automatically responds to PING frames with a PONG frame.
    
    Returns:
    
    true if auto-PONG is enabled
    
    Since:
    
    5.7
  - getCloseWaitTimeout
```
public Timeout getCloseWaitTimeout()
```
    Socket timeout used while waiting for the peer to complete the close handshake.
    
    Returns:
    
    close wait timeout (never null)
    
    Since:
    
    5.7
  - getMaxMessageSize
```
public long getMaxMessageSize()
```
    Maximum accepted message size after fragment reassembly (and after decompression if enabled).
    
    Returns:
    
    maximum message size in bytes (must be > 0)
    
    Since:
    
    5.7
  - getMaxOutboundControlQueue
```
public int getMaxOutboundControlQueue()
```
    Maximum number of queued outbound control frames.
    This bounds memory usage and prevents unbounded growth of control traffic under backpressure.
    
    Returns:
    
    maximum outbound control queue size (must be > 0)
    
    Since:
    
    5.7
  - getMaxOutboundDataBytes
```
public long getMaxOutboundDataBytes()
```
    Upper bound for the total number of bytes queued for outbound data frames.
    When this limit is exceeded, sendText/sendBinary return false and the data frame is rejected. A value of 0 disables the limit.
    
    Returns:
    
    max queued bytes for outbound data frames
    
    Since:
    
    5.7
  - isHttp2Enabled
```
public boolean isHttp2Enabled()
```
    Returns true if HTTP/2 Extended CONNECT (RFC 8441) is enabled.
    
    Since:
    
    5.7
  - custom
```
public static WebSocketClientConfig.Builder custom()
```
    Creates a new builder instance with default settings.
    
    Returns:
    
    builder
    
    Since:
    
    5.7

Class WebSocketClientConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getConnectTimeout

getSubprotocols

isPerMessageDeflateEnabled

isOfferServerNoContextTakeover

isOfferClientNoContextTakeover

getOfferServerMaxWindowBits

getMaxFrameSize

getOutgoingChunkSize

getMaxFramesPerTick

isDirectBuffers

isAutoPong

getCloseWaitTimeout

getMaxMessageSize

getMaxOutboundControlQueue

getMaxOutboundDataBytes

isHttp2Enabled

custom