パッケージ org.springframework.web.reactive.socket.server.support

クラス HandshakeWebSocketService

java.lang.ObjectSE
org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
実装されたすべてのインターフェース:
Lifecycle, WebSocketService
public class HandshakeWebSocketService extends ObjectSE implements WebSocketService, Lifecycle
クラスパスから自動検出（引数なしのコンストラクター）されている RequestUpgradeStrategy に委譲することにより WebSocket HTTP ハンドシェイクリクエストを処理する WebSocketService 実装。明示的に構成することもできます。
導入:
5.0
作成者:
Rossen Stoyanchev, Juergen Hoeller

  • コンストラクターの詳細

    • HandshakeWebSocketService

      public HandshakeWebSocketService()
      使用する RequestUpgradeStrategy のデフォルトコンストラクター自動、クラスパス検出ベースのディスカバリ。

    • HandshakeWebSocketService

      public HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy)
      RequestUpgradeStrategy を使用する代替コンストラクター。
      パラメーター:
      upgradeStrategy - 使用する戦略

  • メソッドの詳細

    • getUpgradeStrategy

      public RequestUpgradeStrategy getUpgradeStrategy()
      WebSocket リクエストに対して RequestUpgradeStrategy を返します。

    • setSessionAttributePredicate

      public void setSessionAttributePredicate(@Nullable PredicateSE<StringSE> predicate)
      WebSession 属性の抽出に使用する述語を構成し、使用して WebSocket セッションを初期化します。

      デフォルトでは、これは設定されていません。この場合、属性は渡されません。

      パラメーター:
      predicate - 述語
      導入:
      5.1

    • getSessionAttributePredicate

      @Nullable public PredicateSE<StringSE> getSessionAttributePredicate()
      WebSession 属性から初期化 WebSocket セッション属性用に構成された述語を返します。
      導入:
      5.1

    • start

      public void start()
      インターフェースからコピーされた説明: Lifecycle
      このコンポーネントを起動します。

      コンポーネントがすでに実行されている場合は、例外をスローしないでください。

      コンテナーの場合、これは適用されるすべてのコンポーネントに開始信号を伝播します。

      次で指定:
      インターフェース Lifecycle の start 
      関連事項:

    • doStart

      protected void doStart()

    • stop

      public void stop()
      インターフェースからコピーされた説明: Lifecycle
      このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。

      この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、Lifecycle Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止信号を事前に考慮することなく呼び出されます。

      コンポーネントが実行されていない（まだ開始されていない）場合は、例外をスローしないでください。

      コンテナーの場合、これは停止信号を適用するすべてのコンポーネントに伝播します。

      次で指定:
      インターフェース Lifecycle の stop 
      関連事項:

    • doStop

      protected void doStop()

    • isRunning

      public boolean isRunning()
      インターフェースからコピーされた説明: Lifecycle
      このコンポーネントが現在実行されているかどうかを確認します。

      コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。

      次で指定:
      インターフェース Lifecycle の isRunning 
      戻り値:
      コンポーネントが現在実行中かどうか

    • handleRequest

      public reactor.core.publisher.Mono<VoidSE> handleRequest(ServerWebExchange exchange, WebSocketHandler handler)
      インターフェースからコピーされた説明: WebSocketService
      指定された WebSocketHandler でリクエストを処理します。
      次で指定:
      インターフェース WebSocketService の handleRequest 
      パラメーター:
      exchange - 現在の交換
      handler - WebSocket セッションのハンドラー
      戻り値:
      WebSocket セッションのアプリケーション処理が完了すると完了する Mono<Void>。