Spring Framework 6.1.4 · org.springframework.web.socket.config.annotation.StompEndpointRegistry

Method Summary

Modifier and Type	Method and Description
public StompWebSocketEndpointRegistration	addEndpoint(String... paths) Register a STOMP over WebSocket endpoint at the given mapping path.
public WebMvcStompEndpointRegistry	setErrorHandler(StompSubProtocolErrorHandler the error handler errorHandler) Configure a handler for customizing or handling STOMP ERROR frames to clients.
public void	setOrder(int order) Set the order of the `org.springframework.web.servlet.HandlerMapping` used for STOMP endpoints relative to other Spring MVC handler mappings.
public WebMvcStompEndpointRegistry	setPreserveReceiveOrder(boolean preserveReceiveOrder) Whether to handle client messages sequentially in the order in which they were received.
public void	setUrlPathHelper(UrlPathHelper urlPathHelper) Configure a customized `UrlPathHelper` for the STOMP endpoint `HandlerMapping`.

Method Detail

addEndpoint	back to summary
public StompWebSocketEndpointRegistration addEndpoint(String... paths) Register a STOMP over WebSocket endpoint at the given mapping path.

setErrorHandler	back to summary
public WebMvcStompEndpointRegistry setErrorHandler(StompSubProtocolErrorHandler errorHandler) Configure a handler for customizing or handling STOMP ERROR frames to clients. Parameters errorHandler:StompSubProtocolErrorHandler the error handler Since 4.2

setErrorHandler

back to summary

public WebMvcStompEndpointRegistry setErrorHandler(StompSubProtocolErrorHandler errorHandler)

Configure a handler for customizing or handling STOMP ERROR frames to clients.

Parameters

errorHandler:StompSubProtocolErrorHandler: the error handler

Since

4.2

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Set the order of the `org.springframework.web.servlet.HandlerMapping` used for STOMP endpoints relative to other Spring MVC handler mappings. By default this is set to 1.

public void setOrder(int order)

Set the order of the org.springframework.web.servlet.HandlerMapping used for STOMP endpoints relative to other Spring MVC handler mappings.

By default this is set to 1.

setPreserveReceiveOrder back to summary

setPreserveReceiveOrder	back to summary
public WebMvcStompEndpointRegistry setPreserveReceiveOrder(boolean preserveReceiveOrder) Whether to handle client messages sequentially in the order in which they were received. By default messages sent to the `"clientInboundChannel"` may be handled in parallel and not in the same order as they were received because the channel is backed by a ThreadPoolExecutor that in turn does not guarantee processing in order. When this flag is set to `true` messages within the same session will be sent to the `"clientInboundChannel"` one at a time in order to preserve the order in which they were received. Since 6.1

public WebMvcStompEndpointRegistry setPreserveReceiveOrder(boolean preserveReceiveOrder)

Whether to handle client messages sequentially in the order in which they were received.

By default messages sent to the "clientInboundChannel" may be handled in parallel and not in the same order as they were received because the channel is backed by a ThreadPoolExecutor that in turn does not guarantee processing in order.

When this flag is set to true messages within the same session will be sent to the "clientInboundChannel" one at a time in order to preserve the order in which they were received.

Since: 6.1

setUrlPathHelper	back to summary
public void setUrlPathHelper(UrlPathHelper urlPathHelper) Configure a customized `UrlPathHelper` for the STOMP endpoint `HandlerMapping`.

public Interface StompEndpointRegistry

Method Summary

Method Detail