クラス JettyWebSocketClient
java.lang.ObjectSE
org.springframework.web.reactive.socket.client.JettyWebSocketClient
- 実装されたすべてのインターフェース:
Lifecycle
,WebSocketClient
@DeprecatedSE(since="6.0.3",
forRemoval=true)
public class JettyWebSocketClient
extends ObjectSE
implements WebSocketClient, Lifecycle
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
Jetty
WebSocketClient
で使用する WebSocketClient
実装。Jetty 11 でのみサポートされ、StandardWebSocketClient
に置き換えられました。 注: Jetty WebSocketClient
はライフサイクル管理を必要とし、開始および停止する必要があります。これは、このクラスが Spring Bean として宣言され、デフォルトのコンストラクターで作成されたときに自動的に管理されます。詳細については、コンストラクターの注意事項を参照してください。
- 導入:
- 5.0
- 作成者:
- Violeta Georgieva, Rossen Stoyanchev, Juergen Hoeller
コンストラクターのサマリー
コンストラクター説明非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。JettyWebSocketClient
のインスタンスを作成および管理するデフォルトのコンストラクター。JettyWebSocketClient
(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。JettyWebSocketClient
の既存のインスタンスを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明reactor.core.publisher.Mono<VoidSE>
execute
(URISE url, HttpHeaders headers, WebSocketHandler handler) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。カスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)
のバリアント。reactor.core.publisher.Mono<VoidSE>
execute
(URISE url, WebSocketHandler handler) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。org.eclipse.jetty.websocket.client.WebSocketClient
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。基になる JettyWebSocketClient
を返します。boolean
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このコンポーネントが現在実行されているかどうかを確認します。void
start()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このコンポーネントを起動します。void
stop()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。
コンストラクターの詳細
JettyWebSocketClient
public JettyWebSocketClient()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。JettyWebSocketClient
のインスタンスを作成および管理するデフォルトのコンストラクター。インスタンスは、さらに構成するためにgetJettyClient()
で取得できます。注: このコンストラクターが使用される場合、このクラスの
Lifecycle
メソッドは JettyWebSocketClient
に委譲されます。JettyWebSocketClient
public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。JettyWebSocketClient
の既存のインスタンスを受け入れるコンストラクター。注: このコンストラクターの使用は、Jetty
WebSocketClient
が外部で管理されているため、このクラスのLifecycle
メソッドが委譲されないことを意味します。
メソッドの詳細
getJettyClient
public org.eclipse.jetty.websocket.client.WebSocketClient getJettyClient()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。基になる JettyWebSocketClient
を返します。start
public void start()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このコンポーネントを起動します。コンポーネントがすでに実行されている場合は、例外をスローしないでください。
コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。
stop
public void stop()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle
とそのstop(Runnable)
バリアントの実装を検討してください。この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、
Lifecycle
Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止シグナルを事前に考慮することなく呼び出されます。コンポーネントが実行されていない(まだ開始されていない)場合は、例外をスローしないでください。
コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。
isRunning
public boolean isRunning()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このコンポーネントが現在実行されているかどうかを確認します。コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、
true
を返します。execute
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:WebSocketClient
指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
url
- ハンドシェイク URLhandler
- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>
の補完。
execute
public reactor.core.publisher.Mono<VoidSE> execute(URISE url, HttpHeaders headers, WebSocketHandler handler) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:WebSocketClient
カスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)
のバリアント。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
url
- ハンドシェイク URLheaders
- ハンドシェイクリクエストのカスタムヘッダーhandler
- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>
の補完。
StandardWebSocketClient
を推奨