Top Description Classes
module tomcat.embed.websocket

Package org.apache.tomcat.websocket.server


Server-side specific implementation classes. These are in a separate package to make packaging a pure client JAR simpler.

Class Summary

Modifier and TypeClass and Description
public class
Constants

Internal implementation constants.

public class
public class
public class
UriTemplate

Extracts path parameters from URIs used to create web socket connections using the URI template defined for the associated Endpoint.

public class
WsContextListener

In normal usage, this ServletContextListener does not need to be explicitly configured as the WsSci performs all the necessary bootstrap and installs this listener in the ServletContext.

public class
WsFilter

Handles the initial HTTP connection for WebSocket connections.

public class
public class
WsHandshakeRequest

Represents the request that this session was opened under.

public class
WsHttpUpgradeHandler

Servlet 3.1 HTTP upgrade handler for WebSocket connections.

pack-priv class
pack-priv class
WsPerSessionServerEndpointConfig

Wraps the provided ServerEndpointConfig and provides a per session view - the difference being that the map returned by getUserProperties() is unique to this instance rather than shared with the wrapped ServerEndpointConfig.

public class
WsRemoteEndpointImplServer

This is the server side jakarta.websocket.RemoteEndpoint implementation - i.e. what the server uses to send data to the client.

public class
WsSci

Registers an interest in any class that is annotated with ServerEndpoint so that Endpoint can be published via the WebSocket server.

public class
WsServerContainer

Provides a per class loader (i.e. per web application) instance of a ServerContainer.

public class
public class
WsWriteTimeout

Provides timeouts for asynchronous web socket writes.