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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoiddestroy()This method is called after the upgraded connection has been closed.voidinit(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.voidpause()Pause processing for the connection.voidpreInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure) voidsetSocketWrapper(SocketWrapperBase<?> socketWrapper) Associate with the specified socket.voidsetSslSupport(SSLSupport sslSupport) Associate with the specified SSL support.voidtimeoutAsync(long now) Check for a possible timeout.upgradeDispatch(SocketEvent status) Process the specified event.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandlerhasAsyncIO
- 
Constructor Details- 
WsHttpUpgradeHandlerpublic WsHttpUpgradeHandler()
 
- 
- 
Method Details- 
setSocketWrapperDescription copied from interface:InternalHttpUpgradeHandlerAssociate with the specified socket.- Specified by:
- setSocketWrapperin interface- InternalHttpUpgradeHandler
- Parameters:
- socketWrapper- the socket
 
- 
preInitpublic void preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure) 
- 
initDescription copied from interface:jakarta.servlet.http.HttpUpgradeHandlerThis 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:
- initin interface- HttpUpgradeHandler
- Parameters:
- connection- The connection that has been upgraded
 
- 
getUpgradeInfo- Specified by:
- getUpgradeInfoin interface- InternalHttpUpgradeHandler
- Returns:
- the associated upgrade information used to collect statistics for the connection
 
- 
upgradeDispatchDescription copied from interface:InternalHttpUpgradeHandlerProcess the specified event.- Specified by:
- upgradeDispatchin interface- InternalHttpUpgradeHandler
- Parameters:
- status- the event
- Returns:
- the status following the event
 
- 
timeoutAsyncpublic void timeoutAsync(long now) Description copied from interface:InternalHttpUpgradeHandlerCheck for a possible timeout.- Specified by:
- timeoutAsyncin interface- InternalHttpUpgradeHandler
- Parameters:
- now- the time to use for the timeout check
 
- 
pausepublic void pause()Description copied from interface:InternalHttpUpgradeHandlerPause processing for the connection.- Specified by:
- pausein interface- InternalHttpUpgradeHandler
 
- 
destroypublic void destroy()Description copied from interface:jakarta.servlet.http.HttpUpgradeHandlerThis method is called after the upgraded connection has been closed.- Specified by:
- destroyin interface- HttpUpgradeHandler
 
- 
setSslSupportDescription copied from interface:InternalHttpUpgradeHandlerAssociate with the specified SSL support.- Specified by:
- setSslSupportin interface- InternalHttpUpgradeHandler
- Parameters:
- sslSupport- the SSL support
 
 
-