org.apache.tomcat.websocket (Apache Tomcat 10.1.57 API Documentation)
Description: declaration: package: org.apache.tomcat.websocket

# Package org.apache.tomcat.websocket

package org.apache.tomcat.websocket

- Related Packages
  Package
  Description
  org.apache.tomcat
  org.apache.tomcat.websocket.pojo
  This package provides the necessary plumbing to convert an annotated POJO into a WebSocket `Endpoint`.
  org.apache.tomcat.websocket.server
  Server-side specific implementation classes.
  org.apache.tomcat.buildutil
  org.apache.tomcat.jni
  org.apache.tomcat.util
- Class
  Description
  AsyncChannelGroupUtil
  This is a utility class that enables multiple `WsWebSocketContainer` instances to share a single `AsynchronousChannelGroup` while ensuring that the group is destroyed when no longer required.
  AsyncChannelWrapper
  This is a wrapper for a `AsynchronousSocketChannel` that limits the methods available thereby simplifying the process of implementing SSL/TLS support since there are fewer methods to intercept.
  AsyncChannelWrapperNonSecure
  Generally, just passes calls straight to the wrapped `AsynchronousSocketChannel`.
  AsyncChannelWrapperSecure
  Wraps the `AsynchronousSocketChannel` with SSL/TLS.
  AuthenticationException
  Exception thrown on authentication error connecting to a remote websocket endpoint.
  AuthenticationType
  Defines the authentication types supported by the WebSocket client.
  Authenticator
  Base class for the authentication methods used by the WebSocket client.
  AuthenticatorFactory
  Utility method to return the appropriate authenticator according to the scheme that the server uses.
  BackgroundProcess
  Interface for objects that need periodic background processing.
  BackgroundProcessManager
  Provides a background processing mechanism that triggers roughly once a second.
  BasicAuthenticator
  Authenticator supporting the BASIC authentication method.
  ClientEndpointHolder
  Holds a client endpoint and provides access to its class name and instance.
  Constants
  Internal implementation constants.
  DecoderEntry
  DigestAuthenticator
  Authenticator supporting the DIGEST authentication method.
  EndpointClassHolder
  Holds a reference to a WebSocket endpoint class for later instantiation.
  EndpointHolder
  Holds a reference to a WebSocket endpoint instance.
  MessageHandlerResult
  MessageHandlerResultType
  Types of message handler results.
  MessagePart
  Represents a part of a WebSocket message.
  PerMessageDeflate
  Implementation of the permessage-deflate WebSocket extension as defined in RFC 7692.
  PojoClassHolder
  Holds a POJO class for use as a WebSocket client endpoint.
  PojoHolder
  Holds a POJO instance for use as a WebSocket client endpoint.
  ReadBufferOverflowException
  Exception thrown when the WebSocket buffer size is insufficient.
  Transformation
  The internal representation of the transformation that a WebSocket extension performs on a message.
  TransformationBuilder
  Builder for creating WebSocket transformations.
  TransformationFactory
  Factory for managing WebSocket transformation builders.
  TransformationResult
  Possible results of a WebSocket frame transformation operation.
  Util
  Utility class for internal use only within the `org.apache.tomcat.websocket` package.
  Util.DecoderMatch
  Holds the result of matching decoders against a target type.
  WrappedMessageHandler
  Interface for message handlers that wrap another message handler.
  WsContainerProvider
  WebSocket container provider for Tomcat.
  WsExtension
  Implementation of WebSocket extension.
  WsExtensionParameter
  Implementation of WebSocket extension parameter.
  WsFrameBase
  Takes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages.
  WsFrameBase.ReadState
  WAITING - not suspended Server case: waiting for a notification that data is ready to be read from the socket, the socket is registered to the poller Client case: data has been read from the socket and is waiting for data to be processed PROCESSING - not suspended Server case: reading from the socket and processing the data Client case: processing the data if such has already been read and more data will be read from the socket SUSPENDING_WAIT - suspended, a call to suspend() was made while in WAITING state.
  WsFrameClient
  WebSocket frame handler for client connections.
  WsHandshakeResponse
  Represents the response to a WebSocket handshake.
  WsIOException
  Allows the WebSocket implementation to throw an `IOException` that includes a `CloseReason` specific to the error that can be passed back to the client.
  WsPongMessage
  WsRemoteEndpointAsync
  Asynchronous remote endpoint for sending WebSocket messages.
  WsRemoteEndpointBase
  Base class for WebSocket remote endpoints.
  WsRemoteEndpointBasic
  Synchronous (basic) remote endpoint for sending WebSocket messages.
  WsRemoteEndpointImplBase
  Base implementation of a WebSocket remote endpoint.
  WsRemoteEndpointImplClient
  Client-side implementation of a WebSocket remote endpoint.
  WsSession
  Implementation of a WebSocket session.
  WsWebSocketContainer
  Client-side WebSocket container implementation.