Index (Apache HttpClient WebSocket 5.7-alpha1 API)

A B C D E F G H I M N O P Q R S T U V W

A

abort() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
abort() - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Immediately abort the transport.
accepted() - Method in class org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport.SendResult
add(WebSocketExtensionChain) - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain
availableForOutput() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Returns queued byte count for the H2 available() callback.
awaitShutdown(TimeValue) - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Best-effort await of shutdown.
awaitShutdown(TimeValue) - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
awaitShutdown(TimeValue) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server

B

BINARY - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
binary(ByteBuffer, boolean) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
bootstrap() - Static method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
bootstrap() - Static method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
build() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Builds an immutable WebSocketClientConfig.
build() - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Builds a new CloseableWebSocketClient instance using the current builder configuration.
build() - Method in class org.apache.hc.core5.websocket.WebSocketConfig.Builder
Builder() - Constructor for class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder
Builder() - Constructor for class org.apache.hc.core5.websocket.WebSocketConfig.Builder

C

canSend() - Method in interface org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport.SendGate
close(int, String) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Initiates the WebSocket close handshake.
close(CloseMode) - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
close() - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
close() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain.DecodeChain: Releases native resources held by the decoders in this chain.
close() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain.EncodeChain: Releases native resources held by the encoders in this chain.
close() - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Decoder: Releases any native resources held by this decoder (e.g. an Inflater).
close() - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Encoder: Releases any native resources held by this encoder (e.g. a Deflater).
CLOSE - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
close(int, String) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
close() - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
close() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension: Releases any native resources held by this extension (e.g. a Deflater or Inflater).
close() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionNegotiation: Releases the native resources held by the negotiated extensions.
close(int, String) - Method in class org.apache.hc.core5.websocket.WebSocketSession
close(WebSocketCloseStatus) - Method in class org.apache.hc.core5.websocket.WebSocketSession
CloseableWebSocketClient - Class in org.apache.hc.client5.http.websocket.client: Public WebSocket client API mirroring CloseableHttpAsyncClient's shape.
CloseableWebSocketClient() - Constructor for class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient
closeCode - Variable in exception org.apache.hc.core5.websocket.exceptions.WebSocketProtocolException
CloseCodec - Class in org.apache.hc.core5.websocket.message: Helpers for RFC6455 CLOSE parsing and validation.
closeEcho(ByteBuffer) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
closeGracefully() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
closeGracefully() - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Initiate a graceful shutdown of the transport.
closeQuietly() - Method in class org.apache.hc.core5.websocket.WebSocketSession
connect(URI, WebSocketListener) - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Convenience overload that uses the client's default configuration and a fresh HttpCoreContext.
connect(URI, WebSocketListener, WebSocketClientConfig) - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Convenience overload that uses a fresh HttpCoreContext.
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Initiates an asynchronous WebSocket connection to the given target URI.
connect(HttpHost, Timeout, Object, FutureCallback<WebSocketEndpointConnector.ProtoEndpoint>) - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketProtocolConnector
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.impl.protocol.Http1UpgradeProtocol
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.impl.protocol.Http2ExtendedConnectProtocol
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in interface org.apache.hc.client5.http.websocket.client.impl.protocol.WebSocketProtocolStrategy: Establish a WebSocket connection using a specific HTTP transport/protocol.
connect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in interface org.apache.hc.client5.http.websocket.client.WebSocketClient: Initiates an asynchronous WebSocket connection to the given target URI.
connected(IOSession) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
CONNECTION - Static variable in class org.apache.hc.core5.websocket.server.WebSocketContextKeys
CONT - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
create() - Static method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Creates a new WebSocketClientBuilder instance.
create(WebSocketExtensionData, boolean) - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtensionFactory
create() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
create() - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
create(WebSocketExtensionData, boolean) - Method in interface org.apache.hc.core5.websocket.WebSocketExtensionFactory
createAcceptKey(String) - Static method in class org.apache.hc.core5.websocket.WebSocketHandshake
createDefault() - Static method in class org.apache.hc.client5.http.websocket.client.WebSocketClients: Creates a CloseableWebSocketClient instance with default configuration.
createDefault() - Static method in class org.apache.hc.core5.websocket.WebSocketExtensionRegistry
createWith(WebSocketClientConfig) - Static method in class org.apache.hc.client5.http.websocket.client.WebSocketClients: Creates a CloseableWebSocketClient instance using the given default WebSocket configuration.
custom() - Static method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Creates a new builder instance with default settings.
custom() - Static method in class org.apache.hc.client5.http.websocket.client.WebSocketClients: Creates a new WebSocketClientBuilder instance for custom client configuration.
custom() - Static method in class org.apache.hc.core5.websocket.WebSocketConfig

D

DataStreamChannelTransport - Class in org.apache.hc.client5.http.websocket.transport: HTTP/2 transport adapter wrapping a DataStreamChannel.
DataStreamChannelTransport() - Constructor for class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
decode(ByteBuffer) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
decode(byte[]) - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain.DecodeChain: Decode a full message (reverse order if stacking).
decode(byte[], long) - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain.DecodeChain: Decode a full message (reverse order if stacking), enforcing a hard cap on the decoded payload size at every step.
decode(byte[]) - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Decoder: Decode a full message produced with this extension.
decode(byte[], long) - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Decoder: Decode a full message, aborting as soon as the produced output exceeds maxDecodedSize.
decode(WebSocketFrameType, boolean, ByteBuffer) - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
decode(WebSocketFrameType, boolean, ByteBuffer, long) - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
decode(WebSocketFrameType, boolean, ByteBuffer) - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
decode(WebSocketFrameType, boolean, ByteBuffer, long) - Method in interface org.apache.hc.core5.websocket.WebSocketExtension: Decode a frame payload, aborting as soon as the produced output exceeds maxOutputSize.
DecodeChain(List<WebSocketExtensionChain.Decoder>) - Constructor for class org.apache.hc.core5.websocket.extension.ExtensionChain.DecodeChain
decodeText(ByteBuffer) - Static method in class org.apache.hc.core5.websocket.WebSocketSession
DEFAULT - Static variable in class org.apache.hc.core5.websocket.WebSocketConfig
defaultConfig(WebSocketClientConfig) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the default configuration applied to WebSocket connections created by the resulting client.
DefaultWebSocketClient - Class in org.apache.hc.client5.http.websocket.client.impl: 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).
DefaultWebSocketClient(HttpAsyncRequester, ManagedConnPool<HttpHost, IOSession>, WebSocketClientConfig, ThreadFactory, H2MultiplexingRequester) - Constructor for class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
disconnected(IOSession) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
doConnect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Core connect hook for subclasses.
doConnect(URI, WebSocketListener, WebSocketClientConfig, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient

E

enableHttp2(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Enables HTTP/2 Extended CONNECT (RFC 8441) for supported endpoints.
enablePerMessageDeflate(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Enables or disables offering permessage-deflate during the handshake.
encode(byte[], boolean, boolean) - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain.EncodeChain: Encode one fragment through the chain; note RSV flag for the first extension.
encode(byte[], boolean, boolean) - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Encoder: Encode one fragment; return transformed payload and whether to set RSV on FIRST frame.
encode(int, String) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Encodes a close status code and reason into a payload suitable for a CLOSE control frame: payload[0] = high-byte of status code payload[1] = low-byte of status code payload[2..] = UTF-8 bytes of the (possibly truncated) reason The reason is internally truncated to ≤ 123 UTF-8 bytes to ensure the resulting payload never exceeds the 125-byte control frame limit.
encode(WebSocketFrameType, boolean, ByteBuffer) - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
encode(WebSocketFrameType, boolean, ByteBuffer) - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
EncodeChain(List<WebSocketExtensionChain.Encoder>) - Constructor for class org.apache.hc.core5.websocket.extension.ExtensionChain.EncodeChain
Encoded(byte[], boolean) - Constructor for class org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Encoded
endStream() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
endStream() - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Signal that the WebSocket stream is ending.
enqueue(int, ByteBuffer, boolean, boolean) - Method in interface org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport.FrameEnqueuer
ensureCapacity(ByteBuffer, int) - Static method in class org.apache.hc.core5.websocket.WebSocketBufferOps
exceedsOutboundByteLimit(long, long, long) - Static method in class org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport
exception(IOSession, Exception) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
execute(AsyncClientExchangeHandler, HandlerFactory<AsyncPushConsumer>, HttpContext) - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector.ProtoEndpoint
execute(Exception) - Method in class org.apache.hc.client5.http.websocket.client.impl.logging.WsLoggingExceptionCallback
exposeWebSocket() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler: Expose the application WebSocket facade.
ExtensionChain - Class in org.apache.hc.core5.websocket.extension: Simple single-step chain; if multiple extensions are added they are applied in order.
ExtensionChain() - Constructor for class org.apache.hc.core5.websocket.extension.ExtensionChain
ExtensionChain.DecodeChain - Class in org.apache.hc.core5.websocket.extension
ExtensionChain.EncodeChain - Class in org.apache.hc.core5.websocket.extension

F

facade() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Returns the application-facing WebSocket.
fin() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
FIN - Static variable in class org.apache.hc.core5.websocket.frame.FrameHeaderBits
format() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionData
formatResponseHeader() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionNegotiation
frame(int, ByteBuffer, boolean, boolean) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
FrameHeaderBits - Class in org.apache.hc.core5.websocket.frame: WebSocket frame header bit masks (RFC 6455 §5.2).
frameInto(int, ByteBuffer, boolean, boolean, ByteBuffer) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
frameIntoWithRSV(int, ByteBuffer, boolean, boolean, int, ByteBuffer) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
FrameOpcode - Class in org.apache.hc.core5.websocket.frame: RFC 6455 opcode constants + helpers.
frameWithRSV(int, ByteBuffer, boolean, boolean, int) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
fromOpcode(int) - Static method in enum org.apache.hc.core5.websocket.WebSocketFrameType

G

getChannel() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
getClientMaxWindowBits() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
getCloseWaitTimeout() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Socket timeout used while waiting for the peer to complete the close handshake.
getCode() - Method in enum org.apache.hc.core5.websocket.WebSocketCloseStatus
getConnectTimeout() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Timeout used for establishing the initial TCP/TLS connection.
getExtensions() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionNegotiation
getInetAddress() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server
getInetAddress() - Method in class org.apache.hc.core5.websocket.server.WebSocketServer
getLocalAddress() - Method in class org.apache.hc.core5.websocket.WebSocketSession
getLocalPort() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server
getLocalPort() - Method in class org.apache.hc.core5.websocket.server.WebSocketServer
getMaxFramePayloadSize() - Method in class org.apache.hc.core5.websocket.WebSocketConfig
getMaxFrameSize() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Maximum accepted WebSocket frame payload size.
getMaxFramesPerTick() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Limit of frames written per reactor "tick".
getMaxMessageSize() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Maximum accepted message size after fragment reassembly (and after decompression if enabled).
getMaxMessageSize() - Method in class org.apache.hc.core5.websocket.WebSocketConfig
getMaxOutboundControlQueue() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Maximum number of queued outbound control frames.
getMaxOutboundDataBytes() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Upper bound for the total number of bytes queued for outbound data frames.
getName() - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
getName() - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtensionFactory
getName() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
getName() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionData
getName() - Method in interface org.apache.hc.core5.websocket.WebSocketExtensionFactory
getOfferServerMaxWindowBits() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Optional value for server_max_window_bits in the PMCE offer.
getOpcode() - Method in enum org.apache.hc.core5.websocket.WebSocketFrameType
getOutgoingChunkSize() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Preferred outgoing fragmentation chunk size.
getParameters() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionData
getPayload() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
getProtocolIOSession() - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector.ProtoEndpoint: Expose the ProtocolIOSession for protocol switching.
getRemoteAddress() - Method in class org.apache.hc.core5.websocket.WebSocketSession
getResponseData() - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
getResponseData() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
getResponseData() - Method in class org.apache.hc.core5.websocket.WebSocketExtensionNegotiation
getServerMaxWindowBits() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
getStatus() - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Current I/O reactor status.
getStatus() - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
getSubprotocols() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Ordered list of WebSocket subprotocols offered to the server via Sec-WebSocket-Protocol.
getType() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
getWebSocket() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketUpgrader: 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>).

H

H2NotAvailable(String) - Constructor for exception org.apache.hc.client5.http.websocket.client.impl.protocol.Http2ExtendedConnectProtocol.H2NotAvailable
Http1UpgradeProtocol - Class in org.apache.hc.client5.http.websocket.client.impl.protocol: HTTP/1.1 Upgrade (RFC 6455).
Http1UpgradeProtocol(HttpAsyncRequester, ManagedConnPool<HttpHost, IOSession>) - Constructor for class org.apache.hc.client5.http.websocket.client.impl.protocol.Http1UpgradeProtocol
Http2ExtendedConnectProtocol - Class in org.apache.hc.client5.http.websocket.client.impl.protocol: RFC 8441 (HTTP/2 Extended CONNECT) WebSocket protocol strategy.
Http2ExtendedConnectProtocol(H2MultiplexingRequester) - Constructor for class org.apache.hc.client5.http.websocket.client.impl.protocol.Http2ExtendedConnectProtocol
Http2ExtendedConnectProtocol.H2NotAvailable - Exception in org.apache.hc.client5.http.websocket.client.impl.protocol

I

initiateShutdown() - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Initiate shutdown (non-blocking).
initiateShutdown() - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
initiateShutdown() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server
initiateShutdown() - Method in class org.apache.hc.core5.websocket.server.WebSocketServer
inputReady(IOSession, ByteBuffer) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
INSTANCE - Static variable in class org.apache.hc.client5.http.websocket.client.impl.logging.WsLoggingExceptionCallback: Singleton instance of LoggingExceptionCallback.
isAutoPong() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Whether the client automatically responds to PING frames with a PONG frame.
isClientNoContextTakeover() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
isConnected() - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector.ProtoEndpoint
isContinuation(int) - Static method in class org.apache.hc.core5.websocket.frame.FrameOpcode: Continuation opcode.
isControl(int) - Static method in class org.apache.hc.core5.websocket.frame.FrameOpcode: Control frames have the high bit set in the low nibble (0x8–0xF).
isControl() - Method in enum org.apache.hc.core5.websocket.WebSocketFrameType
isData(int) - Static method in class org.apache.hc.core5.websocket.frame.FrameOpcode: Data opcodes (not continuation).
isDirectBuffers() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Whether direct byte buffers are preferred for internal I/O.
isEmpty() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain
isEnabled() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
isEndStreamPending() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
isFallbackCandidate(Throwable) - Method in class org.apache.hc.client5.http.websocket.client.impl.protocol.Http2ExtendedConnectProtocol
isFallbackCandidate(Throwable) - Method in interface org.apache.hc.client5.http.websocket.client.impl.protocol.WebSocketProtocolStrategy: Returns true if the given failure is a candidate for protocol fallback (e.g.
isFin() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
isHttp2Enabled() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Returns true if HTTP/2 Extended CONNECT (RFC 8441) is enabled.
isOfferClientNoContextTakeover() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Whether the client offers the client_no_context_takeover PMCE parameter.
isOfferServerNoContextTakeover() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Whether the client offers the server_no_context_takeover PMCE parameter.
isOpen() - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Returns true if the WebSocket is still open and not in the process of closing.
isPerMessageDeflateEnabled() - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig: Whether the client offers the permessage-deflate extension during the handshake.
isRsv1() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
isRsv2() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
isRsv3() - Method in class org.apache.hc.core5.websocket.WebSocketFrame
isServerNoContextTakeover() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
isValidToReceive(int) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Validate a code we PARSED FROM THE WIRE (receiver-side).
isValidToSend(int) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Validate a code we intend to PUT ON THE WIRE (sender-side).
isWebSocketUpgrade(HttpRequest) - Static method in class org.apache.hc.core5.websocket.WebSocketHandshake

M

markEndStreamPending() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
MASK_BIT - Static variable in class org.apache.hc.core5.websocket.frame.FrameHeaderBits

N

name(int) - Static method in class org.apache.hc.core5.websocket.frame.FrameOpcode: Optional: human-readable name for debugging.
negotiate(List<WebSocketExtensionData>, boolean) - Method in class org.apache.hc.core5.websocket.WebSocketExtensionRegistry
newDecodeChain() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain: I/O-thread decoder chain.
newDecoder() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
newDecoder() - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain: Create a thread-confined decoder instance (I/O thread).
newEncodeChain() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain: App-thread encoder chain.
newEncoder() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
newEncoder() - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain: Create a thread-confined encoder instance (app thread).
newH1Protocol(HttpAsyncRequester, ManagedConnPool<HttpHost, IOSession>) - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient: HTTP/1.1 Upgrade protocol.
newH2Protocol(H2MultiplexingRequester) - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient: HTTP/2 Extended CONNECT protocol.
nextOpcode() - Method in class org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport.SendResult

O

offerClientNoContextTakeover(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Offers client_no_context_takeover in the PMCE offer.
offerServerMaxWindowBits(Integer) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Offers server_max_window_bits in the PMCE offer.
offerServerNoContextTakeover(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Offers server_no_context_takeover in the PMCE offer.
onBinary(ByteBuffer, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when a complete binary message has been received.
onBinary(WebSocketSession, ByteBuffer) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onClose(int, String) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when the WebSocket has been closed.
onClose(WebSocketSession, int, String) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onData(ByteBuffer) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Push received bytes into the engine for frame decoding and dispatch.
onDisconnected() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Called when the underlying transport disconnects or the stream ends without a proper close handshake.
onError(Throwable) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when a fatal error occurs on the WebSocket connection.
onError(Exception) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Called when the transport signals an error.
onError(WebSocketSession, Exception) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onOpen(WebSocket) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when the WebSocket connection has been established.
onOpen(WebSocketSession) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onOutputReady() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine: Drain the outbound queues into the transport.
onPing(ByteBuffer) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when a PING control frame is received.
onPing(WebSocketSession, ByteBuffer) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onPong(ByteBuffer) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when a PONG control frame is received.
onPong(WebSocketSession, ByteBuffer) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
onText(CharBuffer, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocketListener: Invoked when a complete text message has been received.
onText(WebSocketSession, String) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
opcode() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
org.apache.hc.client5.http.websocket - package org.apache.hc.client5.http.websocket: Client-side WebSocket support built on top of Apache HttpClient.
org.apache.hc.client5.http.websocket.api - package org.apache.hc.client5.http.websocket.api: Public WebSocket API for client applications.
org.apache.hc.client5.http.websocket.client - package org.apache.hc.client5.http.websocket.client: High-level asynchronous WebSocket client.
org.apache.hc.client5.http.websocket.client.impl - package org.apache.hc.client5.http.websocket.client.impl: Public WebSocket API for client applications.
org.apache.hc.client5.http.websocket.client.impl.connector - package org.apache.hc.client5.http.websocket.client.impl.connector: Message-level helpers and codecs.
org.apache.hc.client5.http.websocket.client.impl.logging - package org.apache.hc.client5.http.websocket.client.impl.logging: Message-level helpers and codecs.
org.apache.hc.client5.http.websocket.client.impl.protocol - package org.apache.hc.client5.http.websocket.client.impl.protocol: Message-level helpers and codecs.
org.apache.hc.client5.http.websocket.transport - package org.apache.hc.client5.http.websocket.transport: Integration with Apache HttpCore I/O reactor.
org.apache.hc.core5.websocket - package org.apache.hc.core5.websocket: WebSocket protocol support and helpers.
org.apache.hc.core5.websocket.exceptions - package org.apache.hc.core5.websocket.exceptions: WebSocket-specific exception types.
org.apache.hc.core5.websocket.extension - package org.apache.hc.core5.websocket.extension: WebSocket extension SPI and implementations.
org.apache.hc.core5.websocket.frame - package org.apache.hc.core5.websocket.frame: Low-level WebSocket frame helpers.
org.apache.hc.core5.websocket.message - package org.apache.hc.core5.websocket.message: Message-level helpers and codecs.
org.apache.hc.core5.websocket.server - package org.apache.hc.core5.websocket.server
OutboundFlowSupport - Class in org.apache.hc.client5.http.websocket.transport: Shared outbound queue and fragmentation helpers used by HTTP/1.1 and HTTP/2 WebSocket transports.
OutboundFlowSupport.FrameEnqueuer - Interface in org.apache.hc.client5.http.websocket.transport
OutboundFlowSupport.SendGate - Interface in org.apache.hc.client5.http.websocket.transport
OutboundFlowSupport.SendResult - Class in org.apache.hc.client5.http.websocket.transport
outputReady(IOSession) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler

P

parse(Header) - Static method in class org.apache.hc.core5.websocket.WebSocketExtensions
parse(Iterator<Header>) - Static method in class org.apache.hc.core5.websocket.WebSocketExtensions: Parses and combines every Sec-WebSocket-Extensions header field.
parseSubprotocols(Header) - Static method in class org.apache.hc.core5.websocket.WebSocketHandshake
payload() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
payload - Variable in class org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Encoded
PerMessageDeflate - Class in org.apache.hc.core5.websocket.extension: permessage-deflate (RFC 7692).
PerMessageDeflate(boolean, boolean, boolean, Integer, Integer) - Constructor for class org.apache.hc.core5.websocket.extension.PerMessageDeflate
PerMessageDeflateExtension - Class in org.apache.hc.core5.websocket
PerMessageDeflateExtension() - Constructor for class org.apache.hc.core5.websocket.PerMessageDeflateExtension
PerMessageDeflateExtensionFactory - Class in org.apache.hc.core5.websocket: Factory for permessage-deflate extensions (RFC 7692).
PerMessageDeflateExtensionFactory() - Constructor for class org.apache.hc.core5.websocket.PerMessageDeflateExtensionFactory
ping(ByteBuffer) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a PING control frame with the given payload.
PING - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
ping(ByteBuffer) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
pong(ByteBuffer) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a PONG control frame with the given payload.
PONG - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
pong(ByteBuffer) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
PSEUDO_PROTOCOL - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants: RFC 8441 extended CONNECT pseudo-header.

Q

queueSize() - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Returns the number of bytes currently queued for outbound transmission.

R

readCloseCode(ByteBuffer) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Reads the close status code from the payload buffer, if present.
readCloseReason(ByteBuffer) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Reads the close reason from the remaining bytes of the payload as UTF-8.
readFrame() - Method in class org.apache.hc.core5.websocket.WebSocketSession
register(String, Supplier<WebSocketHandler>) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
register(String, String, Supplier<WebSocketHandler>) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
register(String, Supplier<WebSocketHandler>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
register(String, String, Supplier<WebSocketHandler>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
register(WebSocketExtensionFactory) - Method in class org.apache.hc.core5.websocket.WebSocketExtensionRegistry
releaseAndDiscard() - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector.ProtoEndpoint
releaseAndReuse() - Method in class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector.ProtoEndpoint
requestOutput() - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
requestOutput() - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Request that the transport arrange a callback to WebSocketSessionEngine.onOutputReady() when the channel is ready for more writes.
rsv1() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
RSV1 - Static variable in class org.apache.hc.core5.websocket.frame.FrameHeaderBits
rsv2() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
RSV2 - Static variable in class org.apache.hc.core5.websocket.frame.FrameHeaderBits
rsv3() - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
RSV3 - Static variable in class org.apache.hc.core5.websocket.frame.FrameHeaderBits
rsvMask() - Method in class org.apache.hc.core5.websocket.extension.ExtensionChain: RSV bits used by the first extension in the chain (if any).
rsvMask() - Method in class org.apache.hc.core5.websocket.extension.PerMessageDeflate
rsvMask() - Method in interface org.apache.hc.core5.websocket.extension.WebSocketExtensionChain: RSV bits this extension uses on the first data frame (e.g. 0x40 for RSV1).

S

SEC_WEBSOCKET_ACCEPT - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_EXTENSIONS - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_EXTENSIONS_LOWER - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_KEY - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_PROTOCOL - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_PROTOCOL_LOWER - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_VERSION - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
SEC_WEBSOCKET_VERSION_LOWER - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
selectSubprotocol(List<String>) - Method in interface org.apache.hc.core5.websocket.WebSocketHandler
sendBinary(ByteBuffer, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a binary message fragment.
sendBinary(ByteBuffer) - Method in class org.apache.hc.core5.websocket.WebSocketSession
sendBinaryBatch(List<ByteBuffer>, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a batch of binary fragments as a single message.
sendFragmented(int, int, ByteBuffer, boolean, int, boolean, OutboundFlowSupport.SendGate, OutboundFlowSupport.FrameEnqueuer) - Static method in class org.apache.hc.client5.http.websocket.transport.OutboundFlowSupport
sendPing(ByteBuffer) - Method in class org.apache.hc.core5.websocket.WebSocketSession
sendPong(ByteBuffer) - Method in class org.apache.hc.core5.websocket.WebSocketSession
sendText(CharSequence, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a text message fragment.
sendText(String) - Method in class org.apache.hc.core5.websocket.WebSocketSession
sendTextBatch(List<CharSequence>, boolean) - Method in interface org.apache.hc.client5.http.websocket.api.WebSocket: Sends a batch of text fragments as a single message.
setAuthorityResolver(BiFunction<String, URIAuthority, URIAuthority>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setAutoPong(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Enables or disables automatic PONG replies for received PING frames.
setCanonicalHostName(String) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setCanonicalHostName(String) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setChannel(DataStreamChannel) - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
setCharCodingConfig(CharCodingConfig) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the character coding configuration for HTTP message processing.
setCharCodingConfig(CharCodingConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setCharCodingConfig(CharCodingConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setCloseWaitTimeout(Timeout) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the close handshake wait timeout.
setConnectionFactory(HttpConnectionFactory<? extends WebSocketServerConnection>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setConnectionReuseStrategy(ConnectionReuseStrategy) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the connection reuse strategy for persistent HTTP connections.
setConnectionReuseStrategy(ConnectionReuseStrategy) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setConnectTimeout(Timeout) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the timeout used to establish the initial TCP/TLS connection.
setConnPoolListener(ConnPoolListener<HttpHost>) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a listener for connection pool events.
setDefaultMaxPerRoute(int) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the default maximum number of connections per route.
setDirectBuffers(boolean) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Enables or disables the use of direct buffers for internal I/O.
setExceptionCallback(Callback<Exception>) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a callback to be notified of fatal I/O exceptions.
setExceptionListener(ExceptionListener) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setExecutor(Executor) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setExtensionRegistry(WebSocketExtensionRegistry) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setExtensionRegistry(WebSocketExtensionRegistry) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setH2Config(H2Config) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the HTTP/2 configuration for the underlying H2 requester.
setH2Config(H2Config) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setH2HttpProcessor(HttpProcessor) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a custom HttpProcessor for the HTTP/2 requester.
setH2StreamListener(H2StreamListener) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setHandshakeTimeout(Timeout) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setHttp1Config(Http1Config) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the HTTP/1.1 configuration for the underlying requester.
setHttp1Config(Http1Config) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setHttp1Config(Http1Config) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setHttp1StreamListener(Http1StreamListener) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setHttpProcessor(HttpProcessor) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a custom HttpProcessor for HTTP/1.1 requests.
setHttpProcessor(HttpProcessor) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setHttpProcessor(HttpProcessor) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setIOReactorConfig(IOReactorConfig) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the I/O reactor configuration.
setIOReactorConfig(IOReactorConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setIOSessionDecorator(Decorator<IOSession>) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a decorator for low-level I/O sessions created by the reactor.
setIOSessionListener(IOSessionListener) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a listener for I/O session lifecycle events.
setListenerPort(int) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setListenerPort(int) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setLocalAddress(InetAddress) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setLocalAddress(InetAddress) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setMaxFramePayloadSize(int) - Method in class org.apache.hc.core5.websocket.WebSocketConfig.Builder
setMaxFrameSize(int) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the maximum accepted frame payload size.
setMaxFramesPerTick(int) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the limit of frames written per reactor tick.
setMaxMessageSize(long) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the maximum accepted message size.
setMaxMessageSize(int) - Method in class org.apache.hc.core5.websocket.WebSocketConfig.Builder
setMaxOutboundControlQueue(int) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the maximum number of queued outbound control frames.
setMaxOutboundDataBytes(long) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the maximum number of bytes that can be queued for outbound data frames.
setMaxPendingCommandsPerConnection(int) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the maximum number of pending commands per HTTP/1.1 connection.
setMaxTotal(int) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the maximum total number of connections in the pool.
setOutgoingChunkSize(int) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the preferred outgoing fragmentation chunk size.
setPoolConcurrencyPolicy(PoolConcurrencyPolicy) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the concurrency policy for the connection pool.
setPoolReusePolicy(PoolReusePolicy) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the reuse policy for connections in the pool.
setReactorMetricsListener(IOReactorMetricsListener) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a metrics listener for the I/O reactor.
setRequestRouter(HttpRequestMapper<Supplier<WebSocketHandler>>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setRsvOnFirst - Variable in class org.apache.hc.core5.websocket.extension.WebSocketExtensionChain.Encoded
setServerSocketFactory(ServerSocketFactory) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setSocketConfig(SocketConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setSslContext(SSLContext) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setSslSetupHandler(Callback<SSLParameters>) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setStreamListener(Http1StreamListener) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets a listener for HTTP/1.1 stream events.
setStreamListener(Http1StreamListener) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
setSubprotocols(List<String>) - Method in class org.apache.hc.client5.http.websocket.api.WebSocketClientConfig.Builder: Sets the ordered list of subprotocols offered to the server.
setThreadFactory(ThreadFactory) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the thread factory used to create the main I/O reactor thread.
setTimeout(Timeout) - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
setTimeout(Timeout) - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Set the I/O timeout on the underlying transport.
setTimeToLive(Timeout) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the time-to-live for persistent connections in the pool.
setTlsHandshakeTimeout(Timeout) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the timeout for the TLS handshake.
setTlsStrategy(TlsStrategy) - Method in class org.apache.hc.client5.http.websocket.client.WebSocketClientBuilder: Sets the TLS strategy used to establish HTTPS or WSS connections.
setTlsStrategy(TlsStrategy) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setVersionPolicy(HttpVersionPolicy) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setWebSocketConfig(WebSocketConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketH2ServerBootstrap
setWebSocketConfig(WebSocketConfig) - Method in class org.apache.hc.core5.websocket.server.WebSocketServerBootstrap
start() - Method in class org.apache.hc.client5.http.websocket.client.CloseableWebSocketClient: Start underlying I/O.
start() - Method in class org.apache.hc.client5.http.websocket.client.impl.DefaultWebSocketClient
start() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server
start() - Method in class org.apache.hc.core5.websocket.server.WebSocketServer
stop() - Method in class org.apache.hc.core5.websocket.server.WebSocketH2Server
stop() - Method in class org.apache.hc.core5.websocket.server.WebSocketServer

T

TEXT - Static variable in class org.apache.hc.core5.websocket.frame.FrameOpcode
text(CharSequence, boolean) - Method in class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
timeout(IOSession, Timeout) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
toBytes(ByteBuffer) - Static method in class org.apache.hc.core5.websocket.WebSocketBufferOps
truncateReasonUtf8(String) - Static method in class org.apache.hc.core5.websocket.message.CloseCodec: Returns a UTF-8 string truncated to ≤ 123 bytes, preserving code-points.

U

upgrade(ProtocolIOSession, FutureCallback<ProtocolIOSession>) - Method in class org.apache.hc.client5.http.websocket.transport.WebSocketUpgrader
usesRsv1() - Method in class org.apache.hc.core5.websocket.PerMessageDeflateExtension
usesRsv1() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
usesRsv2() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension
usesRsv3() - Method in interface org.apache.hc.core5.websocket.WebSocketExtension

V

valueOf(String) - Static method in enum org.apache.hc.core5.websocket.WebSocketCloseStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.hc.core5.websocket.WebSocketFrameType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.hc.core5.websocket.WebSocketCloseStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.hc.core5.websocket.WebSocketFrameType: Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocket - Interface in org.apache.hc.client5.http.websocket.api: Client-side representation of a single WebSocket connection.
WEBSOCKET_GUID - Static variable in class org.apache.hc.core5.websocket.WebSocketConstants
WebSocketBufferOps - Class in org.apache.hc.core5.websocket: Shared low-level buffer operations for WebSocket frame and message handling.
WebSocketClient - Interface in org.apache.hc.client5.http.websocket.client: Client for establishing WebSocket connections using the underlying asynchronous HttpClient infrastructure.
WebSocketClientBuilder - Class in org.apache.hc.client5.http.websocket.client: Builder for CloseableWebSocketClient instances.
WebSocketClientConfig - Class in org.apache.hc.client5.http.websocket.api: Immutable configuration for WebSocket clients.
WebSocketClientConfig.Builder - Class in org.apache.hc.client5.http.websocket.api: Builder for WebSocketClientConfig.
WebSocketClients - Class in org.apache.hc.client5.http.websocket.client: Static factory methods for CloseableWebSocketClient instances.
WebSocketCloseStatus - Enum in org.apache.hc.core5.websocket
WebSocketConfig - Class in org.apache.hc.core5.websocket
WebSocketConfig.Builder - Class in org.apache.hc.core5.websocket
WebSocketConstants - Class in org.apache.hc.core5.websocket
WebSocketContextKeys - Class in org.apache.hc.core5.websocket.server
WebSocketEndpointConnector - Class in org.apache.hc.client5.http.websocket.client.impl.connector: Facade that leases an IOSession from the pool and exposes a ProtocolIOSession through AsyncClientEndpoint.
WebSocketEndpointConnector(HttpAsyncRequester, ManagedConnPool<HttpHost, IOSession>) - Constructor for class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketEndpointConnector
WebSocketEndpointConnector.ProtoEndpoint - Class in org.apache.hc.client5.http.websocket.client.impl.connector
WebSocketException - Exception in org.apache.hc.core5.websocket
WebSocketException(String) - Constructor for exception org.apache.hc.core5.websocket.WebSocketException
WebSocketException(String, Throwable) - Constructor for exception org.apache.hc.core5.websocket.WebSocketException
WebSocketExtension - Interface in org.apache.hc.core5.websocket
WebSocketExtensionChain - Interface in org.apache.hc.core5.websocket.extension: Generic extension hook for payload transform (e.g., permessage-deflate).
WebSocketExtensionChain.Decoder - Interface in org.apache.hc.core5.websocket.extension
WebSocketExtensionChain.Encoded - Class in org.apache.hc.core5.websocket.extension: Encoded fragment result.
WebSocketExtensionChain.Encoder - Interface in org.apache.hc.core5.websocket.extension
WebSocketExtensionData - Class in org.apache.hc.core5.websocket
WebSocketExtensionData(String, Map<String, String>) - Constructor for class org.apache.hc.core5.websocket.WebSocketExtensionData
WebSocketExtensionFactory - Interface in org.apache.hc.core5.websocket
WebSocketExtensionNegotiation - Class in org.apache.hc.core5.websocket
WebSocketExtensionRegistry - Class in org.apache.hc.core5.websocket
WebSocketExtensionRegistry() - Constructor for class org.apache.hc.core5.websocket.WebSocketExtensionRegistry
WebSocketExtensions - Class in org.apache.hc.core5.websocket
WebSocketFrame - Class in org.apache.hc.core5.websocket
WebSocketFrame(boolean, boolean, boolean, boolean, WebSocketFrameType, ByteBuffer) - Constructor for class org.apache.hc.core5.websocket.WebSocketFrame
WebSocketFrameDecoder - Class in org.apache.hc.client5.http.websocket.transport
WebSocketFrameDecoder(int, boolean) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
WebSocketFrameDecoder(int) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
WebSocketFrameDecoder(int, boolean, boolean) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketFrameDecoder
WebSocketFrameType - Enum in org.apache.hc.core5.websocket
WebSocketFrameWriter - Class in org.apache.hc.core5.websocket.frame: RFC 6455 frame writer with helpers to build into an existing target buffer.
WebSocketFrameWriter() - Constructor for class org.apache.hc.core5.websocket.frame.WebSocketFrameWriter
WebSocketH2Server - Class in org.apache.hc.core5.websocket.server
WebSocketH2ServerBootstrap - Class in org.apache.hc.core5.websocket.server: Bootstrap for HTTP/2 WebSocket servers using RFC 8441 (Extended CONNECT).
WebSocketHandler - Interface in org.apache.hc.core5.websocket
WebSocketHandshake - Class in org.apache.hc.core5.websocket
WebSocketIoHandler - Class in org.apache.hc.client5.http.websocket.transport: HTTP/1.1 WebSocket I/O handler.
WebSocketIoHandler(ProtocolIOSession, WebSocketListener, WebSocketClientConfig, ExtensionChain, AsyncClientEndpoint) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketIoHandler
WebSocketListener - Interface in org.apache.hc.client5.http.websocket.api: Callback interface for receiving WebSocket events.
WebSocketProtocolConnector - Class in org.apache.hc.client5.http.websocket.client.impl.connector: Chooses the negotiated WebSocket transport protocol and applies the fallback policy.
WebSocketProtocolConnector(WebSocketProtocolStrategy, WebSocketProtocolStrategy) - Constructor for class org.apache.hc.client5.http.websocket.client.impl.connector.WebSocketProtocolConnector
WebSocketProtocolException - Exception in org.apache.hc.core5.websocket.exceptions
WebSocketProtocolException(int, String) - Constructor for exception org.apache.hc.core5.websocket.exceptions.WebSocketProtocolException
WebSocketProtocolStrategy - Interface in org.apache.hc.client5.http.websocket.client.impl.protocol: Minimal pluggable protocol strategy.
WebSocketServer - Class in org.apache.hc.core5.websocket.server
WebSocketServerBootstrap - Class in org.apache.hc.core5.websocket.server
WebSocketSession - Class in org.apache.hc.core5.websocket
WebSocketSession(WebSocketConfig, InputStream, OutputStream, SocketAddress, SocketAddress, List<WebSocketExtension>) - Constructor for class org.apache.hc.core5.websocket.WebSocketSession
WebSocketSessionEngine - Class in org.apache.hc.client5.http.websocket.transport: Unified WebSocket session engine shared by both HTTP/1.1 and HTTP/2 transports.
WebSocketSessionEngine(WebSocketTransport, WebSocketListener, WebSocketClientConfig, ExtensionChain, ScheduledExecutorService) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketSessionEngine
WebSocketTransport - Interface in org.apache.hc.client5.http.websocket.transport: Abstraction over the underlying I/O channel for a WebSocket session.
WebSocketUpgrader - Class in org.apache.hc.client5.http.websocket.transport: Bridges HttpCore protocol upgrade to a WebSocket WebSocketIoHandler.
WebSocketUpgrader(WebSocketListener, WebSocketClientConfig, ExtensionChain) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketUpgrader
WebSocketUpgrader(WebSocketListener, WebSocketClientConfig, ExtensionChain, AsyncClientEndpoint) - Constructor for class org.apache.hc.client5.http.websocket.transport.WebSocketUpgrader
write(ByteBuffer) - Method in class org.apache.hc.client5.http.websocket.transport.DataStreamChannelTransport
write(ByteBuffer) - Method in interface org.apache.hc.client5.http.websocket.transport.WebSocketTransport: Write bytes to the underlying channel.
WsLoggingExceptionCallback - Class in org.apache.hc.client5.http.websocket.client.impl.logging

A B C D E F G H I M N O P Q R S T U V W