クラス ReactorNettyWebSocketClient
java.lang.ObjectSE
org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
- 実装されたすべてのインターフェース:
WebSocketClient
Reactor Netty で使用する
WebSocketClient
実装。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
コンストラクターコンストラクター説明デフォルトコンストラクター。ReactorNettyWebSocketClient
(reactor.netty.http.client.HttpClient httpClient) デフォルトのWebsocketClientSpec.Builder
を持つ既存のHttpClient
ビルダーを受け入れるコンストラクター。ReactorNettyWebSocketClient
(reactor.netty.http.client.HttpClient httpClient, SupplierSE<reactor.netty.http.client.WebsocketClientSpec.Builder> builderSupplier) 既存のHttpClient
ビルダーと事前構成されたWebsocketClientSpec.Builder
を受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明reactor.core.publisher.Mono<VoidSE>
execute
(URISE url, HttpHeaders requestHeaders, WebSocketHandler handler) カスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)
のバリアント。reactor.core.publisher.Mono<VoidSE>
execute
(URISE url, WebSocketHandler handler) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。boolean
使用すべきではありません。reactor.netty.http.client.HttpClient
設定されたHttpClient
を返します。int
使用すべきではありません。5.3 現在、getWebsocketClientSpec()
を推奨reactor.netty.http.client.WebsocketClientSpec
現在の構成を反映するWebsocketClientSpec
のインスタンスを作成します。void
setHandlePing
(boolean handlePing) 使用すべきではありません。5.3 の時点で、WebsocketClientSpec.Builder
のサプライヤーにコンストラクター引数を提供することを推奨void
setMaxFramePayloadLength
(int maxFramePayloadLength) 使用すべきではありません。5.3 の時点で、WebsocketClientSpec.Builder
のサプライヤーにコンストラクター引数を提供することを推奨
コンストラクターの詳細
ReactorNettyWebSocketClient
public ReactorNettyWebSocketClient()デフォルトコンストラクター。ReactorNettyWebSocketClient
public ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient) デフォルトのWebsocketClientSpec.Builder
を持つ既存のHttpClient
ビルダーを受け入れるコンストラクター。- 導入:
- 5.1
ReactorNettyWebSocketClient
public ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient, SupplierSE<reactor.netty.http.client.WebsocketClientSpec.Builder> builderSupplier) 既存のHttpClient
ビルダーと事前構成されたWebsocketClientSpec.Builder
を受け入れるコンストラクター。- 導入:
- 5.3
メソッドの詳細
getHttpClient
public reactor.netty.http.client.HttpClient getHttpClient()設定されたHttpClient
を返します。getWebsocketClientSpec
public reactor.netty.http.client.WebsocketClientSpec getWebsocketClientSpec()現在の構成を反映するWebsocketClientSpec
のインスタンスを作成します。これは、特定のアップグレードに使用されるWebSocketHandler
に依存するサブプロトコルを除いて、構成されたパラメーターを確認するために使用できます。- 導入:
- 5.3
setMaxFramePayloadLength
使用すべきではありません。5.3 の時点で、WebsocketClientSpec.Builder
のサプライヤーにコンストラクター引数を提供することを推奨最大許容フレームペイロード長を設定します。この値をアプリケーションの要件に設定すると、長いデータフレームを使用したサービス拒否攻撃を減らすことができます。Netty の
WebSocketServerHandshakerFactory
のコンストラクターにある同じ名前の引数に対応します。デフォルトでは、65536(64K)に設定されています。
- パラメーター:
maxFramePayloadLength
- フレームの最大長。- 導入:
- 5.2
getMaxFramePayloadLength
使用すべきではありません。5.3 現在、getWebsocketClientSpec()
を推奨設定されたmaxFramePayloadLength
を返します。- 導入:
- 5.2
setHandlePing
使用すべきではありません。5.3 の時点で、WebsocketClientSpec.Builder
のサプライヤーにコンストラクター引数を提供することを推奨execute メソッドに指定されたWebSocketHandler
が ping フレームを処理するかどうかを構成します。デフォルトでは、Reactor Netty は ping にレスポンスしてポンフレームで自動的にレスポンスします。これは、ping および pong フレームの通過を許可するプロキシで役立ちます。デフォルトでは、これは
false
に設定されています。この場合、ping フレームは Reactor Netty によって自動的に処理されます。true
に設定すると、ping フレームはWebSocketHandler
にパススルーされます。- パラメーター:
handlePing
- 処理のために Ping フレームを通過させるかどうか- 導入:
- 5.2.4
getHandlePing
使用すべきではありません。5.3 現在、getWebsocketClientSpec()
を推奨設定されたsetHandlePing(boolean)
を返します。- 導入:
- 5.2.4
execute
インターフェースからコピーされた説明:WebSocketClient
指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
url
- ハンドシェイク URLhandler
- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>
の補完。
execute
public reactor.core.publisher.Mono<VoidSE> execute(URISE url, HttpHeaders requestHeaders, WebSocketHandler handler) インターフェースからコピーされた説明:WebSocketClient
カスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)
のバリアント。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
url
- ハンドシェイク URLrequestHeaders
- ハンドシェイクリクエストのカスタムヘッダーhandler
- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>
の補完。
getWebsocketClientSpec()
を推奨