Package org.apache.tomcat.websocket
package org.apache.tomcat.websocket
-
ClassDescriptionThis is a utility class that enables multiple
WsWebSocketContainerinstances to share a singleAsynchronousChannelGroupwhile ensuring that the group is destroyed when no longer required.This is a wrapper for aAsynchronousSocketChannelthat limits the methods available thereby simplifying the process of implementing SSL/TLS support since there are fewer methods to intercept.Generally, just passes calls straight to the wrappedAsynchronousSocketChannel.Wraps theAsynchronousSocketChannelwith SSL/TLS.Exception thrown on authentication error connecting to a remote websocket endpoint.Defines the authentication types supported by the WebSocket client.Base class for the authentication methods used by the WebSocket client.Utility method to return the appropriate authenticator according to the scheme that the server uses.Interface for objects that need periodic background processing.Provides a background processing mechanism that triggers roughly once a second.Authenticator supporting the BASIC authentication method.Holds a client endpoint and provides access to its class name and instance.Internal implementation constants.Authenticator supporting the DIGEST authentication method.Holds a reference to a WebSocket endpoint class for later instantiation.Holds a reference to a WebSocket endpoint instance.Types of message handler results.Represents a part of a WebSocket message.Implementation of the permessage-deflate WebSocket extension as defined in RFC 7692.Holds a POJO class for use as a WebSocket client endpoint.Holds a POJO instance for use as a WebSocket client endpoint.Exception thrown when the WebSocket buffer size is insufficient.The internal representation of the transformation that a WebSocket extension performs on a message.Builder for creating WebSocket transformations.Factory for managing WebSocket transformation builders.Possible results of a WebSocket frame transformation operation.Utility class for internal use only within theorg.apache.tomcat.websocketpackage.Holds the result of matching decoders against a target type.Interface for message handlers that wrap another message handler.WebSocket container provider for Tomcat.Implementation of WebSocket extension.Implementation of WebSocket extension parameter.Takes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages.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.WebSocket frame handler for client connections.Represents the response to a WebSocket handshake.Allows the WebSocket implementation to throw anIOExceptionthat includes aCloseReasonspecific to the error that can be passed back to the client.Asynchronous remote endpoint for sending WebSocket messages.Base class for WebSocket remote endpoints.Synchronous (basic) remote endpoint for sending WebSocket messages.Base implementation of a WebSocket remote endpoint.Client-side implementation of a WebSocket remote endpoint.Implementation of a WebSocket session.Client-side WebSocket container implementation.