# Package org.apache.tomcat.websocket

- Interface Summary
  Interface | Description
  --- | ---
  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.
  BackgroundProcess |
  Transformation | The internal representation of the transformation that a WebSocket extension performs on a message.
  WrappedMessageHandler |

- Class Summary
  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.
  AsyncChannelWrapperNonSecure | Generally, just passes calls straight to the wrapped `AsynchronousSocketChannel`.
  AsyncChannelWrapperSecure | Wraps the `AsynchronousSocketChannel` with SSL/TLS.
  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.
  BackgroundProcessManager | Provides a background processing mechanism that triggers roughly once a second.
  BasicAuthenticator | Authenticator supporting the BASIC auth method.
  Constants | Internal implementation constants.
  DecoderEntry |
  DigestAuthenticator | Authenticator supporting the DIGEST auth method.
  MessageHandlerResult |
  PerMessageDeflate |
  TransformationFactory |
  Util | Utility class for internal use only within the `org.apache.tomcat.websocket` package.
  Util.DecoderMatch |
  WsContainerProvider |
  WsExtension |
  WsExtensionParameter |
  WsFrameBase | Takes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages.
  WsFrameClient |
  WsHandshakeResponse | Represents the response to a WebSocket handshake.
  WsPongMessage |
  WsRemoteEndpointAsync |
  WsRemoteEndpointBase |
  WsRemoteEndpointBasic |
  WsRemoteEndpointImplBase |
  WsRemoteEndpointImplClient |
  WsSession |
  WsWebSocketContainer |

- Enum Summary
  Enum | Description
  --- | ---
  MessageHandlerResultType |
  TransformationResult |

  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.

- Exception Summary
  Exception | Description
  --- | ---
  AuthenticationException | Exception thrown on authentication error connecting to a remote websocket endpoint.
  ReadBufferOverflowException |
  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.

Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.