Package org.springframework.web.socket.config.annotation

Interface StompEndpointRegistry

All Known Implementing Classes:
WebMvcStompEndpointRegistry
public interface StompEndpointRegistry
A contract for registering STOMP over WebSocket endpoints.
Since:
4.0
Author:
Rossen Stoyanchev

  • Method Details

    • addEndpoint

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

    • setOrder

      void setOrder(int order)
      Set the order of the HandlerMapping used for STOMP endpoints relative to other Spring MVC handler mappings.

      By default this is set to 1.

    • setUrlPathHelper

      void setUrlPathHelper(UrlPathHelper urlPathHelper)
      Configure a customized UrlPathHelper for the STOMP endpoint HandlerMapping.

    • setErrorHandler

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

    • setPreserveReceiveOrder

      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