org.apache.hc.client5.http.websocket.transport

Class WebSocketSessionEngine

java.lang.Object

org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine

@Internal
public final class WebSocketSessionEngine
extends Object

Unified WebSocket session engine shared by both HTTP/1.1 and HTTP/2 transports.

Combines frame decoding (inbound), frame encoding with queue management (outbound), close-handshake logic, and the application-facing WebSocket facade. All transport-specific I/O is delegated to a WebSocketTransport.

Thread model: onData(ByteBuffer) and onOutputReady() must be called from the I/O thread. The WebSocket facade methods may be called from any thread; they use a write lock for queue access.

Constructor Summary

Constructors

Constructor and Description
WebSocketSessionEngine(WebSocketTransport transport, WebSocketListener listener, WebSocketClientConfig cfg, ExtensionChain chain, ScheduledExecutorService closeTimer)

Method Summary

Modifier and Type	Method and Description
int	availableForOutput() Returns queued byte count for the H2 available() callback.
WebSocket	facade() Returns the application-facing WebSocket.
void	onData(ByteBuffer src) Push received bytes into the engine for frame decoding and dispatch.
void	onDisconnected() Called when the underlying transport disconnects or the stream ends without a proper close handshake.
void	onError(Exception cause) Called when the transport signals an error.
boolean	onOutputReady() Drain the outbound queues into the transport.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketSessionEngine

public WebSocketSessionEngine(WebSocketTransport transport,
                              WebSocketListener listener,
                              WebSocketClientConfig cfg,
                              ExtensionChain chain,
                              ScheduledExecutorService closeTimer)

Parameters:

transport - the underlying I/O channel

listener - application callback

cfg - client configuration

chain - negotiated extension chain (may be null)

closeTimer - scheduled executor for H2 close timeout; null for H1 (H1 uses WebSocketTransport.setTimeout(org.apache.hc.core5.util.Timeout) instead)

Method Detail

facade

public WebSocket facade()

Returns the application-facing WebSocket.

onData

public void onData(ByteBuffer src)

Push received bytes into the engine for frame decoding and dispatch. Called from the I/O thread.

onDisconnected

public void onDisconnected()

Called when the underlying transport disconnects or the stream ends without a proper close handshake.

onError

public void onError(Exception cause)

Called when the transport signals an error.

onOutputReady

public boolean onOutputReady()

Drain the outbound queues into the transport. Called from the I/O thread when the channel is ready for writing.

Returns:

true if more output is pending (caller should keep the write interest), false if queues are empty

availableForOutput

public int availableForOutput()

Returns queued byte count for the H2 available() callback.