All Classes and Interfaces (WebSocket 2.1 API Documentation - Apache Tomcat 10.1.57)
Description: class index

# All Classes and Interfaces

Class
Description
ClientEndpoint
Annotates a class as a WebSocket client endpoint.
ClientEndpointConfig
Provides configuration information for WebSocket client endpoints.
ClientEndpointConfig.Builder
Builder for creating `ClientEndpointConfig` instances.
ClientEndpointConfig.Configurator
Provides a mechanism to customize the WebSocket handshake for client endpoints.
CloseReason
Represents the reason for the closure of a WebSocket connection, including a close code and an optional reason phrase.
CloseReason.CloseCode
Represents a WebSocket close code.
CloseReason.CloseCodes
Standard WebSocket close codes as defined by RFC 6455 and related specifications.
ContainerProvider
Use the `ServiceLoader` mechanism to provide instances of the WebSocket client container.
DecodeException
Exception thrown when a decoder fails to decode a WebSocket message.
Decoder
Base interface for WebSocket message decoders.
Decoder.Binary<T>
A decoder that decodes entire binary WebSocket messages into an object of type T.
Decoder.BinaryStream<T>
A decoder that decodes entire binary WebSocket messages from an input stream into an object of type T.
Decoder.Text<T>
A decoder that decodes entire text WebSocket messages into an object of type T.
Decoder.TextStream<T>
A decoder that decodes entire text WebSocket messages from a reader into an object of type T.
DeploymentException
Exception thrown when a WebSocket endpoint cannot be deployed due to a configuration error.
EncodeException
Exception thrown when an encoder fails to encode an object as a WebSocket message.
Encoder
Base interface for WebSocket message encoders.
Encoder.Binary<T>
An encoder that encodes an object of type T into a binary WebSocket message.
Encoder.BinaryStream<T>
An encoder that encodes an object of type T into a binary WebSocket message written to an `OutputStream`.
Encoder.Text<T>
An encoder that encodes an object of type T into a text WebSocket message.
Encoder.TextStream<T>
An encoder that encodes an object of type T into a text WebSocket message written to a `Writer`.
Endpoint
Base class for programmatic WebSocket endpoints.
EndpointConfig
Provides configuration information for a WebSocket endpoint, including encoders, decoders, and user properties.
Extension
Represents a WebSocket extension that can be negotiated during the handshake.
Extension.Parameter
Represents a parameter of a WebSocket extension.
HandshakeRequest
Represents the HTTP request that asked to be upgraded to WebSocket.
HandshakeResponse
Represents the HTTP response returned by the server during a WebSocket handshake.
MessageHandler
Base interface for WebSocket message handlers.
MessageHandler.Partial<T>
A message handler that receives partial (fragmented) messages.
MessageHandler.Whole<T>
A message handler that receives whole (complete) messages.
OnClose
Annotates a method on a POJO endpoint to handle the close event.
OnError
Annotates a method on a POJO endpoint to handle error events.
OnMessage
Annotates a method on a POJO endpoint to handle incoming WebSocket messages.
OnOpen
Annotates a method on a POJO endpoint to handle the open event.
PathParam
Used to annotate method parameters on POJO endpoints the the `ServerEndpoint` has been defined with a `ServerEndpoint.value()` that uses a URI template.
PongMessage
Represents a WebSocket Pong message and used by message handlers to enable applications to process the response to any Pings they send.
RemoteEndpoint
Interface for sending messages to the remote endpoint of a WebSocket session.
RemoteEndpoint.Async
Asynchronous API for sending messages to the remote endpoint.
RemoteEndpoint.Basic
Synchronous (blocking) API for sending messages to the remote endpoint.
SendHandler
Callback interface for handling the result of an asynchronous WebSocket message send operation.
SendResult
Represents the result of an asynchronous WebSocket message send operation.
ServerApplicationConfig
Applications may provide an implementation of this interface to filter the discovered WebSocket endpoints that are deployed.
ServerContainer
Provides the ability to deploy endpoints programmatically.
ServerEndpoint
Annotates a class as a WebSocket server endpoint.
ServerEndpointConfig
Provides configuration information for WebSocket endpoints published to a server.
ServerEndpointConfig.Builder
Builder for creating `ServerEndpointConfig` instances.
ServerEndpointConfig.Configurator
Provides a mechanism to customize the WebSocket handshake for server endpoints.
Session
Represents a WebSocket session, which is the WebSocket connection between a client and a server.
SessionException
Exception thrown when an error occurs on a WebSocket session.
WebSocketContainer
Provides the ability to create new WebSocket client connections.