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

Interface WebSocketClient

All Known Implementing Classes:

CloseableWebSocketClient, DefaultWebSocketClient

public interface WebSocketClient

Client for establishing WebSocket connections using the underlying asynchronous HttpClient infrastructure.

This interface represents the minimal contract for initiating WebSocket handshakes. Implementations are expected to be thread-safe.

Since:

5.7

Method Summary

Modifier and Type	Method and Description
CompletableFuture<WebSocket>	connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context) Initiates an asynchronous WebSocket connection to the given target URI.

Method Detail

connect

CompletableFuture<WebSocket> connect(URI uri,
                                     WebSocketListener listener,
                                     WebSocketClientConfig cfg,
                                     HttpContext context)

Initiates an asynchronous WebSocket connection to the given target URI.

The URI must use the ws or wss scheme. This method performs an HTTP/1.1 upgrade to the WebSocket protocol and, on success, creates a WebSocket associated with the supplied WebSocketListener.

The operation is fully asynchronous. The returned CompletableFuture completes when the opening WebSocket handshake has either succeeded or failed.

Parameters:

uri - target WebSocket URI, must not be null.

listener - callback that receives WebSocket events, must not be null.

cfg - optional per-connection configuration; if null, the client’s default configuration is used.

context - optional HTTP context for the underlying upgrade request; may be null.

Returns:

a future that completes with a connected WebSocket on success, or completes exceptionally if the connection attempt or protocol handshake fails.

Since:

5.7