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

Class DefaultWebSocketClient

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, WebSocketClient, ModalCloseable

@Contract(threading=SAFE_CONDITIONAL)
 @Internal
public class DefaultWebSocketClient
extends CloseableWebSocketClient

Default WebSocket client implementation that manages the I/O reactor lifecycle, connection pool, and protocol strategy selection (HTTP/1.1 Upgrade or HTTP/2 Extended CONNECT with automatic fallback).

Instances are created via WebSocketClientBuilder.

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketClient(HttpAsyncRequester requester, ManagedConnPool<HttpHost,IOSession> connPool, WebSocketClientConfig defaultConfig, ThreadFactory threadFactory, H2MultiplexingRequester h2Requester)

Method Summary

Modifier and Type	Method and Description
void	awaitShutdown(TimeValue waitTime) Best-effort await of shutdown.
void	close()
void	close(CloseMode closeMode)
protected CompletableFuture<WebSocket>	doConnect(URI uri, WebSocketListener listener, WebSocketClientConfig cfgOrNull, HttpContext context) Core connect hook for subclasses.
IOReactorStatus	getStatus() Current I/O reactor status.
void	initiateShutdown() Initiate shutdown (non-blocking).
protected WebSocketProtocolStrategy	newH1Protocol(HttpAsyncRequester requester, ManagedConnPool<HttpHost,IOSession> connPool) HTTP/1.1 Upgrade protocol.
protected WebSocketProtocolStrategy	newH2Protocol(H2MultiplexingRequester requester) HTTP/2 Extended CONNECT protocol.
void	start() Start underlying I/O.

Methods inherited from class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient

connect, connect, connect

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketClient

public DefaultWebSocketClient(HttpAsyncRequester requester,
                              ManagedConnPool<HttpHost,IOSession> connPool,
                              WebSocketClientConfig defaultConfig,
                              ThreadFactory threadFactory,
                              H2MultiplexingRequester h2Requester)

Method Detail

newH1Protocol

protected WebSocketProtocolStrategy newH1Protocol(HttpAsyncRequester requester,
                                                  ManagedConnPool<HttpHost,IOSession> connPool)

HTTP/1.1 Upgrade protocol.

newH2Protocol

protected WebSocketProtocolStrategy newH2Protocol(H2MultiplexingRequester requester)

HTTP/2 Extended CONNECT protocol.

start

public final void start()

Description copied from class: CloseableWebSocketClient

Start underlying I/O. Safe to call once; subsequent calls are no-ops.

Specified by:

start in class CloseableWebSocketClient

getStatus

public final IOReactorStatus getStatus()

Description copied from class: CloseableWebSocketClient

Current I/O reactor status.

Specified by:

getStatus in class CloseableWebSocketClient

awaitShutdown

public final void awaitShutdown(TimeValue waitTime)
                         throws InterruptedException

Description copied from class: CloseableWebSocketClient

Best-effort await of shutdown.

Specified by:

awaitShutdown in class CloseableWebSocketClient

Throws:

InterruptedException

initiateShutdown

public final void initiateShutdown()

Description copied from class: CloseableWebSocketClient

Initiate shutdown (non-blocking).

Specified by:

initiateShutdown in class CloseableWebSocketClient

close

public final void close(CloseMode closeMode)

close

public void close()

doConnect

protected CompletableFuture<WebSocket> doConnect(URI uri,
                                                 WebSocketListener listener,
                                                 WebSocketClientConfig cfgOrNull,
                                                 HttpContext context)

Description copied from class: CloseableWebSocketClient

Core connect hook for subclasses.

Specified by:

doConnect in class CloseableWebSocketClient

Parameters:

uri - target WebSocket URI (ws:// or wss://)

listener - application callbacks

cfgOrNull - optional per-connection config (may be null for defaults)

context - optional HTTP context (may be null)