spring-framework / org.springframework.web.socket.config.annotation / WebMvcStompEndpointRegistry

WebMvcStompEndpointRegistry

open class WebMvcStompEndpointRegistry : StompEndpointRegistry

A registry for STOMP over WebSocket endpoints that maps the endpoints with a org.springframework.web.servlet.HandlerMapping for use in Spring MVC.

Author
Rossen Stoyanchev

Author
Artem Bilan

Since
4.0

Constructors

<init>

WebMvcStompEndpointRegistry(webSocketHandler: WebSocketHandler, transportRegistration: WebSocketTransportRegistration, defaultSockJsTaskScheduler: TaskScheduler)

Functions

addEndpoint	`open fun addEndpoint(vararg paths: String): StompWebSocketEndpointRegistration`
getHandlerMapping	`open fun getHandlerMapping(): AbstractHandlerMapping` Return a handler mapping with the mapped ViewControllers.
setErrorHandler	`open fun setErrorHandler(errorHandler: StompSubProtocolErrorHandler): WebMvcStompEndpointRegistry`
setOrder	`open fun setOrder(order: Int): Unit` Set the order for the resulting org.springframework.web.servlet.HandlerMapping relative to other handler mappings configured in Spring MVC. The default value is 1.
setUrlPathHelper	`open fun setUrlPathHelper(urlPathHelper: UrlPathHelper): Unit` Set the UrlPathHelper to configure on the `HandlerMapping` used to map handshake requests.