WebSocketClientConfig.Builder (Apache HttpClient WebSocket 5.7-alpha1 API)

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

Enclosing class:

WebSocketClientConfig
```
public static final class WebSocketClientConfig.Builder
extends Object
```
Builder for WebSocketClientConfig.
The builder is mutable and not thread-safe.

Since:

5.7

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebSocketClientConfig`	`build()` Builds an immutable `WebSocketClientConfig`.
`WebSocketClientConfig.Builder`	`enableHttp2(boolean enabled)` Enables HTTP/2 Extended CONNECT (RFC 8441) for supported endpoints.
`WebSocketClientConfig.Builder`	`enablePerMessageDeflate(boolean v)` Enables or disables offering `permessage-deflate` during the handshake.
`WebSocketClientConfig.Builder`	`offerClientNoContextTakeover(boolean v)` Offers `client_no_context_takeover` in the PMCE offer.
`WebSocketClientConfig.Builder`	`offerServerMaxWindowBits(Integer v)` Offers `server_max_window_bits` in the PMCE offer.
`WebSocketClientConfig.Builder`	`offerServerNoContextTakeover(boolean v)` Offers `server_no_context_takeover` in the PMCE offer.
`WebSocketClientConfig.Builder`	`setAutoPong(boolean v)` Enables or disables automatic PONG replies for received PING frames.
`WebSocketClientConfig.Builder`	`setCloseWaitTimeout(Timeout v)` Sets the close handshake wait timeout.
`WebSocketClientConfig.Builder`	`setConnectTimeout(Timeout v)` Sets the timeout used to establish the initial TCP/TLS connection.
`WebSocketClientConfig.Builder`	`setDirectBuffers(boolean v)` Enables or disables the use of direct buffers for internal I/O.
`WebSocketClientConfig.Builder`	`setMaxFrameSize(int v)` Sets the maximum accepted frame payload size.
`WebSocketClientConfig.Builder`	`setMaxFramesPerTick(int v)` Sets the limit of frames written per reactor tick.
`WebSocketClientConfig.Builder`	`setMaxMessageSize(long v)` Sets the maximum accepted message size.
`WebSocketClientConfig.Builder`	`setMaxOutboundControlQueue(int v)` Sets the maximum number of queued outbound control frames.
`WebSocketClientConfig.Builder`	`setMaxOutboundDataBytes(long v)` Sets the maximum number of bytes that can be queued for outbound data frames.
`WebSocketClientConfig.Builder`	`setOutgoingChunkSize(int v)` Sets the preferred outgoing fragmentation chunk size.
`WebSocketClientConfig.Builder`	`setSubprotocols(List<String> v)` Sets the ordered list of subprotocols offered to the server.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setConnectTimeout
```
public WebSocketClientConfig.Builder setConnectTimeout(Timeout v)
```
    Sets the timeout used to establish the initial TCP/TLS connection.
    
    Parameters:
    
    v - timeout, may be null to rely on defaults
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setSubprotocols
```
public WebSocketClientConfig.Builder setSubprotocols(List<String> v)
```
    Sets the ordered list of subprotocols offered to the server.
    
    Parameters:
    
    v - list of subprotocol names, may be null to offer none
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - enablePerMessageDeflate
```
public WebSocketClientConfig.Builder enablePerMessageDeflate(boolean v)
```
    Enables or disables offering permessage-deflate during the handshake.
    
    Parameters:
    
    v - true to offer PMCE, false otherwise
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - offerServerNoContextTakeover
```
public WebSocketClientConfig.Builder offerServerNoContextTakeover(boolean v)
```
    Offers server_no_context_takeover in the PMCE offer.
    
    Parameters:
    
    v - whether to include the parameter in the offer
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - offerClientNoContextTakeover
```
public WebSocketClientConfig.Builder offerClientNoContextTakeover(boolean v)
```
    Offers client_no_context_takeover in the PMCE offer.
    
    Parameters:
    
    v - whether to include the parameter in the offer
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - offerServerMaxWindowBits
```
public WebSocketClientConfig.Builder offerServerMaxWindowBits(Integer v)
```
    Offers 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.
    
    Parameters:
    
    v - window bits, or null to omit the parameter
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setMaxFrameSize
```
public WebSocketClientConfig.Builder setMaxFrameSize(int v)
```
    Sets the maximum accepted frame payload size.
    
    Parameters:
    
    v - maximum frame payload size in bytes (must be > 0)
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setOutgoingChunkSize
```
public WebSocketClientConfig.Builder setOutgoingChunkSize(int v)
```
    Sets the preferred outgoing fragmentation chunk size.
    
    Parameters:
    
    v - chunk size in bytes (must be > 0)
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setMaxFramesPerTick
```
public WebSocketClientConfig.Builder setMaxFramesPerTick(int v)
```
    Sets the limit of frames written per reactor tick.
    
    Parameters:
    
    v - max frames per tick (must be > 0)
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setDirectBuffers
```
public WebSocketClientConfig.Builder setDirectBuffers(boolean v)
```
    Enables or disables the use of direct buffers for internal I/O.
    
    Parameters:
    
    v - true for direct buffers, false for heap buffers
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setAutoPong
```
public WebSocketClientConfig.Builder setAutoPong(boolean v)
```
    Enables or disables automatic PONG replies for received PING frames.
    
    Parameters:
    
    v - true to auto-reply with PONG
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setCloseWaitTimeout
```
public WebSocketClientConfig.Builder setCloseWaitTimeout(Timeout v)
```
    Sets the close handshake wait timeout.
    
    Parameters:
    
    v - close wait timeout, must not be null
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setMaxMessageSize
```
public WebSocketClientConfig.Builder setMaxMessageSize(long v)
```
    Sets the maximum accepted message size.
    
    Parameters:
    
    v - max message size in bytes (must be > 0)
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setMaxOutboundControlQueue
```
public WebSocketClientConfig.Builder setMaxOutboundControlQueue(int v)
```
    Sets the maximum number of queued outbound control frames.
    
    Parameters:
    
    v - max control queue size (must be > 0)
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - setMaxOutboundDataBytes
```
public WebSocketClientConfig.Builder setMaxOutboundDataBytes(long v)
```
    Sets the maximum number of bytes that can be queued for outbound data frames.
    When the limit is exceeded, sendText/sendBinary return false. A value of 0 disables the limit.
    
    Parameters:
    
    v - max queued bytes for outbound data frames
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - enableHttp2
```
public WebSocketClientConfig.Builder enableHttp2(boolean enabled)
```
    Enables HTTP/2 Extended CONNECT (RFC 8441) for supported endpoints.
    
    Parameters:
    
    enabled - true to enable HTTP/2 WebSocket connections
    
    Returns:
    
    this builder
    
    Since:
    
    5.7
  - build
```
public WebSocketClientConfig build()
```
    Builds an immutable WebSocketClientConfig.
    
    Returns:
    
    configuration instance
    
    Throws:
    
    IllegalArgumentException - if any parameter is invalid
    
    Since:
    
    5.7

Class WebSocketClientConfig.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setConnectTimeout

setSubprotocols

enablePerMessageDeflate

offerServerNoContextTakeover

offerClientNoContextTakeover

offerServerMaxWindowBits

setMaxFrameSize

setOutgoingChunkSize

setMaxFramesPerTick

setDirectBuffers

setAutoPong

setCloseWaitTimeout

setMaxMessageSize

setMaxOutboundControlQueue

setMaxOutboundDataBytes

enableHttp2

build