open class WebSocketHttpRequestHandler : HttpRequestHandler, Lifecycle, ServletContextAware
A HttpRequestHandler for processing WebSocket handshake requests.
This is the main class to use when configuring a server WebSocket at a specific URL. It is a very thin wrapper around a WebSocketHandler and a HandshakeHandler, also adapting the HttpServletRequest and HttpServletResponse to ServerHttpRequest and ServerHttpResponse, respectively.
Author
Rossen Stoyanchev
Since
4.0
WebSocketHttpRequestHandler(wsHandler: WebSocketHandler)WebSocketHttpRequestHandler(wsHandler: WebSocketHandler, handshakeHandler: HandshakeHandler) |
open fun getHandshakeHandler(): HandshakeHandler
Return the HandshakeHandler. |
|
open fun getHandshakeInterceptors(): MutableList<HandshakeInterceptor>
Return the configured WebSocket handshake request interceptors. |
|
open fun getWebSocketHandler(): WebSocketHandler
Return the WebSocketHandler. |
|
open fun handleRequest(servletRequest: HttpServletRequest, servletResponse: HttpServletResponse): Unit |
|
open fun isRunning(): Boolean |
|
open fun setHandshakeInterceptors(interceptors: MutableList<HandshakeInterceptor>): Unit
Configure one or more WebSocket handshake request interceptors. |
|
open fun setServletContext(servletContext: ServletContext): Unit |
|
open fun start(): Unit |
|
open fun stop(): Unit |