spring-framework / org.springframework.web.socket.sockjs.transport.handler / WebSocketTransportHandler

WebSocketTransportHandler

open class WebSocketTransportHandler : AbstractTransportHandler, SockJsSessionFactory, HandshakeHandler, Lifecycle, ServletContextAware

WebSocket-based TransportHandler. Uses SockJsWebSocketHandler and WebSocketServerSockJsSession to add SockJS processing.

Also implements HandshakeHandler to support raw WebSocket communication at SockJS URL "/websocket".

Author
Rossen Stoyanchev

Since
4.0

Constructors

<init>

 WebSocketTransportHandler(handshakeHandler: HandshakeHandler)

Functions

checkSessionType

 open fun checkSessionType(session: SockJsSession): Boolean

createSession

 open fun createSession(id: String, handler: WebSocketHandler, attrs: MutableMap<String, Any>): AbstractSockJsSession

doHandshake

 open fun doHandshake(request: ServerHttpRequest, response: ServerHttpResponse, handler: WebSocketHandler, attributes: MutableMap<String, Any>): Boolean

getHandshakeHandler

 open fun getHandshakeHandler(): HandshakeHandler

getTransportType

 open fun getTransportType(): TransportType

handleRequest

 open fun handleRequest(request: ServerHttpRequest, response: ServerHttpResponse, wsHandler: WebSocketHandler, wsSession: SockJsSession): Unit

isRunning

 open fun isRunning(): Boolean

setServletContext

 open fun setServletContext(servletContext: ServletContext): Unit

start

 open fun start(): Unit

stop

 open fun stop(): Unit