クラス WebMvcStompEndpointRegistry
java.lang.ObjectSE
org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
- 実装されているすべてのインターフェース:
StompEndpointRegistry
Spring MVC で使用するためにエンドポイントを
HandlerMapping にマップする WebSocket エンドポイント上の STOMP のレジストリ。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Artem Bilan
コンストラクターの概要
コンストラクターコンストラクター説明WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler, WebSocketTransportRegistration transportRegistration, TaskScheduler defaultSockJsTaskScheduler) メソッドのサマリー
修飾子と型メソッド説明addEndpoint(StringSE... paths) 特定のマッピングパスで SZMP over WebSocket エンドポイントを登録します。マップされた ViewControllers でハンドラーマッピングを返します。protected intgetOrder()protected @Nullable UrlPathHelper非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。protected booleanprotected voidsetApplicationContext(ApplicationContext applicationContext) setErrorHandler(StompSubProtocolErrorHandler errorHandler) クライアントに対する STOMP ERROR フレームをカスタマイズまたは処理するためのハンドラーを構成します。voidsetOrder(int order) Spring MVC で構成された他のハンドラーマッピングに対して、結果のHandlerMappingの順序を設定します。setPreserveReceiveOrder(boolean preserveReceiveOrder) クライアントメッセージを受信した順序で順次処理するかどうか。voidsetUrlPathHelper(@Nullable UrlPathHelper urlPathHelper) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
コンストラクターの詳細
WebMvcStompEndpointRegistry
public WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler, WebSocketTransportRegistration transportRegistration, TaskScheduler defaultSockJsTaskScheduler)
メソッドの詳細
addEndpoint
インターフェースからコピーされた説明:StompEndpointRegistry特定のマッピングパスで SZMP over WebSocket エンドポイントを登録します。- 次で指定:
- インターフェース
StompEndpointRegistryのaddEndpoint
setOrder
public void setOrder(int order) Spring MVC で構成された他のハンドラーマッピングに対して、結果のHandlerMappingの順序を設定します。デフォルト値は 1 です。
- 次で指定:
- インターフェース
StompEndpointRegistryのsetOrder
getOrder
protected int getOrder()setUrlPathHelper
@DeprecatedSE(since="7.0", forRemoval=true) public void setUrlPathHelper(@Nullable UrlPathHelper urlPathHelper) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。PathMatcherおよびUrlPathHelperの使用は、Web モジュールでの実行時の使用では非推奨となり、代わりにPathPatternParserによる解析パターンが推奨されます。ハンドシェイクリクエストのマップに使用されるHandlerMappingで構成する UrlPathHelper を設定します。- 次で指定:
- インターフェース
StompEndpointRegistryのsetUrlPathHelper
getUrlPathHelper
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。setErrorHandler
インターフェースからコピーされた説明:StompEndpointRegistryクライアントに対する STOMP ERROR フレームをカスタマイズまたは処理するためのハンドラーを構成します。- 次で指定:
- インターフェース
StompEndpointRegistryのsetErrorHandler - パラメーター:
errorHandler- エラーハンドラー
setPreserveReceiveOrder
インターフェースからコピーされた説明:StompEndpointRegistryクライアントメッセージを受信した順序で順次処理するかどうか。デフォルトでは、
"clientInboundChannel"に送信されたメッセージは、受信したときと同じ順序ではなく並行して処理される場合があります。これは、チャネルが ThreadPoolExecutor によってサポートされており、順序どおりに処理されることが保証されていないためです。このフラグが
trueに設定されている場合、同じセッション内のメッセージは、受信された順序を維持するために一度に 1 つずつ"clientInboundChannel"に送信されます。- 次で指定:
- インターフェース
StompEndpointRegistryのsetPreserveReceiveOrder
isPreserveReceiveOrder
protected boolean isPreserveReceiveOrder()setApplicationContext
getHandlerMapping
マップされた ViewControllers でハンドラーマッピングを返します。
PathMatcherおよびUrlPathHelperの使用は、Web モジュールでの実行時の使用では非推奨となり、代わりにPathPatternParserによる解析パターンが推奨されます。