パッケージ org.springframework.web.reactive.socket.adapter

クラス ContextWebSocketHandler

java.lang.ObjectSE
org.springframework.web.reactive.socket.adapter.ContextWebSocketHandler
実装されたすべてのインターフェース:
WebSocketHandler
public final class ContextWebSocketHandler extends ObjectSE implements WebSocketHandler
ターゲットハンドラーのコンテキストを強化する WebSocketHandler デコレーター。
導入:
5.3.3
作成者:
Rossen Stoyanchev

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static WebSocketHandler
    decorate(WebSocketHandler handler, reactor.util.context.ContextView contextView)
    指定されたコンテキストを挿入するように装飾された指定されたハンドラー、またはコンテキストが空の場合は同じハンドラーインスタンスを返します。
    ListSE<StringSE>
    getSubProtocols()
    このハンドラーでサポートされているサブプロトコルのリストを返します。
    reactor.core.publisher.Mono<VoidSE>
    handle(WebSocketSession session)
    新しい WebSocket 接続が確立されたときに呼び出され、セッションの処理を許可します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • メソッドの詳細

    • getSubProtocols

      public ListSE<StringSE> getSubProtocols()
      インターフェースからコピーされた説明: WebSocketHandler
      このハンドラーでサポートされているサブプロトコルのリストを返します。

      デフォルトでは、空のリストが返されます。

      次で指定:
      インターフェース WebSocketHandler の getSubProtocols 

    • handle

      public reactor.core.publisher.Mono<VoidSE> handle(WebSocketSession session)
      インターフェースからコピーされた説明: WebSocketHandler
      新しい WebSocket 接続が確立されたときに呼び出され、セッションの処理を許可します。

      セッションの処理方法の詳細と例については、クラスレベルのドキュメントとリファレンスマニュアルを参照してください。

      次で指定:
      インターフェース WebSocketHandler の handle 
      パラメーター:
      session - 処理するセッション
      戻り値:
      セッションのアプリケーション処理がいつ完了するかを示します。これは、受信メッセージストリームの補完（つまり、接続の終了）と、場合によっては送信メッセージストリームの補完とメッセージの書き込みを反映する必要があります。

    • decorate

      public static WebSocketHandler decorate(WebSocketHandler handler, reactor.util.context.ContextView contextView)
      指定されたコンテキストを挿入するように装飾された指定されたハンドラー、またはコンテキストが空の場合は同じハンドラーインスタンスを返します。