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

クラス ReactorNettyRequestUpgradeStrategy

java.lang.ObjectSE
org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
実装されたすべてのインターフェース:
RequestUpgradeStrategy
public class ReactorNettyRequestUpgradeStrategy extends ObjectSE implements RequestUpgradeStrategy
Reactor Netty 用の WebSocket RequestUpgradeStrategy。
導入:
5.0
作成者:
Rossen Stoyanchev

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

    • ReactorNettyRequestUpgradeStrategy

      public ReactorNettyRequestUpgradeStrategy()
      デフォルトの WebsocketServerSpec.Builder でインスタンスを作成します。
      導入:
      5.2.6

    • ReactorNettyRequestUpgradeStrategy

      public ReactorNettyRequestUpgradeStrategy(SupplierSE<reactor.netty.http.server.WebsocketServerSpec.Builder> builderSupplier)
      WebSocket のアップグレードに使用する、事前構成された WebsocketServerSpec.Builder を使用してインスタンスを作成します。
      導入:
      5.2.6

  • メソッドの詳細

    • getWebsocketServerSpec

      public reactor.netty.http.server.WebsocketServerSpec getWebsocketServerSpec()
      現在の構成を反映する WebsocketServerSpec のインスタンスを作成します。これは、特定のアップグレードに使用される WebSocketHandler に依存するサブプロトコルを除いて、構成されたパラメーターを確認するために使用できます。
      導入:
      5.2.6

    • setMaxFramePayloadLength

      @DeprecatedSE public void setMaxFramePayloadLength(IntegerSE maxFramePayloadLength)
      使用すべきではありません。
      5.2.6 の時点で、WebsocketServerSpec.Builder のサプライヤーにコンストラクター引数を提供することを推奨
      最大許容フレームペイロード長を設定します。この値をアプリケーションの要件に設定すると、長いデータフレームを使用したサービス拒否攻撃を減らすことができます。

      Netty の WebSocketServerHandshakerFactory のコンストラクターにある同じ名前の引数に対応します。

      デフォルトでは、65536（64K）に設定されています。

      パラメーター:
      maxFramePayloadLength - フレームの最大長。
      導入:
      5.1

    • getMaxFramePayloadLength

      @DeprecatedSE public int getMaxFramePayloadLength()
      使用すべきではありません。
      5.2.6 現在、getWebsocketServerSpec() を推奨
      フレームに設定された最大長を返します。
      導入:
      5.1

    • setHandlePing

      @DeprecatedSE public void setHandlePing(boolean handlePing)
      使用すべきではありません。
      5.2.6 の時点で、WebsocketServerSpec.Builder のサプライヤーにコンストラクター引数を提供することを推奨
      アップグレードメソッドに指定された WebSocketHandler によって処理されるように ping フレームを通過させるかどうかを構成します。デフォルトでは、Reactor Netty は、ping にレスポンスしてポンフレームで自動的にレスポンスします。これは、ping および pong フレームを通過させるためのプロキシで役立ちます。

      デフォルトでは、これは false に設定されています。この場合、ping フレームは Reactor Netty によって自動的に処理されます。true に設定すると、ping フレームは WebSocketHandler にパススルーされます。

      パラメーター:
      handlePing - 処理のために Ping フレームを通過させるかどうか
      導入:
      5.2.4

    • getHandlePing

      @DeprecatedSE public boolean getHandlePing()
      使用すべきではありません。
      5.2.6 現在、getWebsocketServerSpec() を推奨
      設定された setHandlePing(boolean) を返します。
      導入:
      5.2.4

    • upgrade

      public reactor.core.publisher.Mono<VoidSE> upgrade(ServerWebExchange exchange, WebSocketHandler handler, @Nullable StringSE subProtocol, SupplierSE<HandshakeInfo> handshakeInfoFactory)
      インターフェースからコピーされた説明: RequestUpgradeStrategy
      WebSocket セッションにアップグレードし、指定されたハンドラーで処理します。
      次で指定:
      インターフェース RequestUpgradeStrategy の upgrade 
      パラメーター:
      exchange - 現在の交換
      handler - WebSocket セッションのハンドラー
      subProtocol - 選択したサブプロトコルがハンドラーを取得しました
      handshakeInfoFactory - WebSocket セッションの HandshakeInfo を作成するファクトリ
      戻り値:
      WebSocket セッション処理の結果を示す Mono<Void> の補完。