Uses of Interface
org.apache.hc.client5.http.websocket.api.WebSocket

Packages that use WebSocket

Package	Description
org.apache.hc.client5.http.websocket.api	Public WebSocket API for client applications.
org.apache.hc.client5.http.websocket.client	High-level asynchronous WebSocket client.
org.apache.hc.client5.http.websocket.client.impl	Public WebSocket API for client applications.
org.apache.hc.client5.http.websocket.client.impl.connector	Message-level helpers and codecs.
org.apache.hc.client5.http.websocket.client.impl.protocol	Message-level helpers and codecs.
org.apache.hc.client5.http.websocket.transport	Integration with Apache HttpCore I/O reactor.

Uses of WebSocket in org.apache.hc.client5.http.websocket.api

Methods in org.apache.hc.client5.http.websocket.api with parameters of type WebSocket

Modifier and Type	Method and Description
default void	WebSocketListener.onOpen(WebSocket webSocket) Invoked when the WebSocket connection has been established.

Uses of WebSocket in org.apache.hc.client5.http.websocket.client

Methods in org.apache.hc.client5.http.websocket.client that return types with arguments of type WebSocket

Modifier and Type	Method and Description
CompletableFuture<WebSocket>	CloseableWebSocketClient.connect(URI uri, WebSocketListener listener) Convenience overload that uses the client's default configuration and a fresh HttpCoreContext.
CompletableFuture<WebSocket>	CloseableWebSocketClient.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg) Convenience overload that uses a fresh HttpCoreContext.
CompletableFuture<WebSocket>	WebSocketClient.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context) Initiates an asynchronous WebSocket connection to the given target URI.
CompletableFuture<WebSocket>	CloseableWebSocketClient.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context) Initiates an asynchronous WebSocket connection to the given target URI.
protected abstract CompletableFuture<WebSocket>	CloseableWebSocketClient.doConnect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context) Core connect hook for subclasses.

Uses of WebSocket in org.apache.hc.client5.http.websocket.client.impl

Methods in org.apache.hc.client5.http.websocket.client.impl that return types with arguments of type WebSocket

Modifier and Type	Method and Description
protected CompletableFuture<WebSocket>	DefaultWebSocketClient.doConnect(URI uri, WebSocketListener listener, WebSocketClientConfig cfgOrNull, HttpContext context)

Uses of WebSocket in org.apache.hc.client5.http.websocket.client.impl.connector

Methods in org.apache.hc.client5.http.websocket.client.impl.connector that return types with arguments of type WebSocket

Modifier and Type	Method and Description
CompletableFuture<WebSocket>	WebSocketProtocolConnector.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context)

Uses of WebSocket in org.apache.hc.client5.http.websocket.client.impl.protocol

Methods in org.apache.hc.client5.http.websocket.client.impl.protocol that return types with arguments of type WebSocket

Modifier and Type	Method and Description
CompletableFuture<WebSocket>	Http1UpgradeProtocol.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context)
CompletableFuture<WebSocket>	WebSocketProtocolStrategy.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context) Establish a WebSocket connection using a specific HTTP transport/protocol.
CompletableFuture<WebSocket>	Http2ExtendedConnectProtocol.connect(URI uri, WebSocketListener listener, WebSocketClientConfig cfg, HttpContext context)

Uses of WebSocket in org.apache.hc.client5.http.websocket.transport

Methods in org.apache.hc.client5.http.websocket.transport that return WebSocket

Modifier and Type	Method and Description
WebSocket	WebSocketIoHandler.exposeWebSocket() Expose the application WebSocket facade.
WebSocket	WebSocketSessionEngine.facade() Returns the application-facing WebSocket.
WebSocket	WebSocketUpgrader.getWebSocket() Returns the WebSocket created during WebSocketUpgrader.upgrade(org.apache.hc.core5.reactor.ProtocolIOSession, org.apache.hc.core5.concurrent.FutureCallback<org.apache.hc.core5.reactor.ProtocolIOSession>).