Class WsHttpUpgradeHandler
java.lang.Object
org.apache.tomcat.websocket.server.WsHttpUpgradeHandler
- All Implemented Interfaces:
HttpUpgradeHandler
,InternalHttpUpgradeHandler
Servlet 3.1 HTTP upgrade handler for WebSocket connections.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
This method is called after the upgraded connection has been closed.void
init
(WebConnection connection) This method is called once the request/response pair whereHttpServletRequest.upgrade(Class)
is called has completed processing and is the point where control of the connection passes from the container to theHttpUpgradeHandler
.void
pause()
Pause processing for the connection.void
preInit
(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure) void
setSocketWrapper
(SocketWrapperBase<?> socketWrapper) Associate with the specified socket.void
setSslSupport
(SSLSupport sslSupport) Associate with the specified SSL support.void
timeoutAsync
(long now) Check for a possible timeout.upgradeDispatch
(SocketEvent status) Process the specified event.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler
hasAsyncIO
-
Constructor Details
-
WsHttpUpgradeHandler
public WsHttpUpgradeHandler()
-
-
Method Details
-
setSocketWrapper
Description copied from interface:InternalHttpUpgradeHandler
Associate with the specified socket.- Specified by:
setSocketWrapper
in interfaceInternalHttpUpgradeHandler
- Parameters:
socketWrapper
- the socket
-
preInit
public void preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure) -
init
Description copied from interface:javax.servlet.http.HttpUpgradeHandler
This method is called once the request/response pair whereHttpServletRequest.upgrade(Class)
is called has completed processing and is the point where control of the connection passes from the container to theHttpUpgradeHandler
.- Specified by:
init
in interfaceHttpUpgradeHandler
- Parameters:
connection
- The connection that has been upgraded
-
getUpgradeInfo
- Specified by:
getUpgradeInfo
in interfaceInternalHttpUpgradeHandler
- Returns:
- the associated upgrade information used to collect statistics for the connection
-
upgradeDispatch
Description copied from interface:InternalHttpUpgradeHandler
Process the specified event.- Specified by:
upgradeDispatch
in interfaceInternalHttpUpgradeHandler
- Parameters:
status
- the event- Returns:
- the status following the event
-
timeoutAsync
public void timeoutAsync(long now) Description copied from interface:InternalHttpUpgradeHandler
Check for a possible timeout.- Specified by:
timeoutAsync
in interfaceInternalHttpUpgradeHandler
- Parameters:
now
- the time to use for the timeout check
-
pause
public void pause()Description copied from interface:InternalHttpUpgradeHandler
Pause processing for the connection.- Specified by:
pause
in interfaceInternalHttpUpgradeHandler
-
destroy
public void destroy()Description copied from interface:javax.servlet.http.HttpUpgradeHandler
This method is called after the upgraded connection has been closed.- Specified by:
destroy
in interfaceHttpUpgradeHandler
-
setSslSupport
Description copied from interface:InternalHttpUpgradeHandler
Associate with the specified SSL support.- Specified by:
setSslSupport
in interfaceInternalHttpUpgradeHandler
- Parameters:
sslSupport
- the SSL support
-