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

ServletWebSocketHandlerRegistry

open class ServletWebSocketHandlerRegistry : WebSocketHandlerRegistry

A WebSocketHandlerRegistry that maps WebSocketHandlers to URLs for use in a Servlet container.

Author
Rossen Stoyanchev

Since
4.0

Constructors

<init>

ServletWebSocketHandlerRegistry()ServletWebSocketHandlerRegistry(scheduler: ThreadPoolTaskScheduler)

Deprecated constructor with a TaskScheduler for SockJS use.

Functions

addHandler

open fun addHandler(handler: WebSocketHandler, vararg paths: String): WebSocketHandlerRegistration

getHandlerMapping

open fun getHandlerMapping(): AbstractHandlerMapping

getOrder

open fun getOrder(): Int

getUrlPathHelper

open fun getUrlPathHelper(): UrlPathHelper

setOrder

open fun setOrder(order: Int): Unit

Set the order for the resulting SimpleUrlHandlerMapping 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 SimpleUrlHandlerMapping used to map handshake requests.