Tomcat 10.1.19 · org.apache.tomcat.websocket · APIdia, the JavaDoc alternative

Modifier and Type	Interface and Description
public interface	AsyncChannelWrapper This is a wrapper for a `java.nio.channels.AsynchronousSocketChannel` that limits the methods available thereby simplifying the process of implementing SSL/TLS support since there are fewer methods to intercept.
public interface	BackgroundProcess
public interface	ClientEndpointHolder
public interface	Transformation The internal representation of the transformation that a WebSocket extension performs on a message.
public interface	WrappedMessageHandler

Class Summary

Modifier and Type	Class and Description
public class	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.
public class	AsyncChannelWrapperNonSecure Generally, just passes calls straight to the wrapped `AsynchronousSocketChannel`.
public class	AsyncChannelWrapperSecure Wraps the `AsynchronousSocketChannel` with SSL/TLS.
public class	AuthenticationException Exception thrown on authentication error connecting to a remote websocket endpoint.
public abstract class	Authenticator Base class for the authentication methods used by the WebSocket client.
public class	AuthenticatorFactory Utility method to return the appropriate authenticator according to the scheme that the server uses.
public class	BackgroundProcessManager Provides a background processing mechanism that triggers roughly once a second.
public class	BasicAuthenticator Authenticator supporting the BASIC authentication method.
public class	Constants Internal implementation constants.
public class	DecoderEntry
public class	DigestAuthenticator Authenticator supporting the DIGEST authentication method.
public class	EndpointClassHolder
public class	EndpointHolder
pack-priv class	FutureToSendHandler Converts a Future to a SendHandler.
public class	MessageHandlerResult
pack-priv class	MessagePart
public class	PerMessageDeflate
public class	PojoClassHolder
public class	PojoHolder
public class	ReadBufferOverflowException
public class	TransformationFactory
public class	Util Utility class for internal use only within the `org.apache.tomcat.websocket` package.
public class	WsContainerProvider
public class	WsExtension
public class	WsExtensionParameter
public abstract class	WsFrameBase Takes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages.
public class	WsFrameClient
public class	WsHandshakeResponse Represents the response to a WebSocket handshake.
public class	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.
public class	WsPongMessage
public class	WsRemoteEndpointAsync
public abstract class	WsRemoteEndpointBase
public class	WsRemoteEndpointBasic
public abstract class	WsRemoteEndpointImplBase
public class	WsRemoteEndpointImplClient
public class	WsSession
public class	WsWebSocketContainer

Modifier and Type	Enum and Description
public enum	AuthenticationType
public enum	MessageHandlerResultType
public enum	TransformationResult

Package org.apache.tomcat.websocket

Interface Summary

Class Summary

Enum Summary