org.apache.hc.client5.http.websocket.client

Class WebSocketClients

java.lang.Object

org.apache.hc.client5.http.websocket.client.WebSocketClients

public final class WebSocketClients
extends Object

Static factory methods for CloseableWebSocketClient instances.

This is a convenience entry point for typical client creation scenarios. For advanced configuration use WebSocketClientBuilder directly.

Clients created by these helpers own their I/O resources and must be closed when no longer needed.

Since:

5.7

Method Summary

Modifier and Type	Method and Description
static CloseableWebSocketClient	createDefault() Creates a CloseableWebSocketClient instance with default configuration.
static CloseableWebSocketClient	createWith(WebSocketClientConfig defaultConfig) Creates a CloseableWebSocketClient instance using the given default WebSocket configuration.
static WebSocketClientBuilder	custom() Creates a new WebSocketClientBuilder instance for custom client configuration.

Methods inherited from class java.lang.Object

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

Method Detail

custom

public static WebSocketClientBuilder custom()

Creates a new WebSocketClientBuilder instance for custom client configuration.

Returns:

a new WebSocketClientBuilder.

createDefault

public static CloseableWebSocketClient createDefault()

Creates a CloseableWebSocketClient instance with default configuration.

Returns:

a newly created CloseableWebSocketClient using default settings.

createWith

public static CloseableWebSocketClient createWith(WebSocketClientConfig defaultConfig)

Creates a CloseableWebSocketClient instance using the given default WebSocket configuration.

Parameters:

defaultConfig - default configuration applied to WebSocket connections created by the client; must not be null.

Returns:

a newly created CloseableWebSocketClient.