Class WsHttpUpgradeHandler
- java.lang.Object
-
- org.apache.tomcat.websocket.server.WsHttpUpgradeHandler
-
- All Implemented Interfaces:
HttpUpgradeHandler,InternalHttpUpgradeHandler
public class WsHttpUpgradeHandler extends Object implements InternalHttpUpgradeHandler
Servlet 3.1 HTTP upgrade handler for WebSocket connections.
-
-
Constructor Summary
Constructors Constructor Description WsHttpUpgradeHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddestroy()This method is called after the upgraded connection has been closed.UpgradeInfogetUpgradeInfo()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()voidpreInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String,String> pathParameters, boolean secure)voidsetSocketWrapper(SocketWrapperBase<?> socketWrapper)voidsetSslSupport(SSLSupport sslSupport)voidtimeoutAsync(long now)AbstractEndpoint.Handler.SocketStateupgradeDispatch(SocketEvent status)-
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
-
-
-
-
Method Detail
-
setSocketWrapper
public void setSocketWrapper(SocketWrapperBase<?> socketWrapper)
- Specified by:
setSocketWrapperin interfaceInternalHttpUpgradeHandler
-
preInit
public void preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String,String> pathParameters, boolean secure)
-
init
public void init(WebConnection connection)
Description copied from interface:javax.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 interfaceHttpUpgradeHandler- Parameters:
connection- The connection that has been upgraded
-
getUpgradeInfo
public UpgradeInfo getUpgradeInfo()
- Specified by:
getUpgradeInfoin interfaceInternalHttpUpgradeHandler
-
upgradeDispatch
public AbstractEndpoint.Handler.SocketState upgradeDispatch(SocketEvent status)
- Specified by:
upgradeDispatchin interfaceInternalHttpUpgradeHandler
-
timeoutAsync
public void timeoutAsync(long now)
- Specified by:
timeoutAsyncin interfaceInternalHttpUpgradeHandler
-
pause
public void pause()
- Specified by:
pausein interfaceInternalHttpUpgradeHandler
-
destroy
public void destroy()
Description copied from interface:javax.servlet.http.HttpUpgradeHandlerThis method is called after the upgraded connection has been closed.- Specified by:
destroyin interfaceHttpUpgradeHandler
-
setSslSupport
public void setSslSupport(SSLSupport sslSupport)
- Specified by:
setSslSupportin interfaceInternalHttpUpgradeHandler
-
-