クラス HandshakeWebSocketService
java.lang.ObjectSE
org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- 実装されたすべてのインターフェース:
Lifecycle
,WebSocketService
クラスパスから自動検出(引数なしのコンストラクター)されている
RequestUpgradeStrategy
に委譲することにより WebSocket HTTP ハンドシェイクリクエストを処理する WebSocketService
実装。明示的に構成することもできます。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller
コンストラクターのサマリー
コンストラクター説明使用するRequestUpgradeStrategy
のデフォルトコンストラクター自動、クラスパス検出ベースのディスカバリ。HandshakeWebSocketService
(RequestUpgradeStrategy upgradeStrategy) RequestUpgradeStrategy
を使用する代替コンストラクター。メソッドのサマリー
修飾子と型メソッド説明protected void
doStart()
protected void
doStop()
WebSession
属性から初期化 WebSocket セッション属性用に構成された述語を返します。WebSocket リクエストに対してRequestUpgradeStrategy
を返します。reactor.core.publisher.Mono<VoidSE>
handleRequest
(ServerWebExchange exchange, WebSocketHandler handler) 指定されたWebSocketHandler
でリクエストを処理します。boolean
このコンポーネントが現在実行されているかどうかを確認します。void
setSessionAttributePredicate
(PredicateSE<StringSE> predicate) WebSession
属性の抽出に使用する述語を構成し、使用して WebSocket セッションを初期化します。void
start()
このコンポーネントを起動します。void
stop()
このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。
コンストラクターの詳細
HandshakeWebSocketService
public HandshakeWebSocketService()使用するRequestUpgradeStrategy
のデフォルトコンストラクター自動、クラスパス検出ベースのディスカバリ。HandshakeWebSocketService
RequestUpgradeStrategy
を使用する代替コンストラクター。- パラメーター:
upgradeStrategy
- 使用する戦略
メソッドの詳細
getUpgradeStrategy
WebSocket リクエストに対してRequestUpgradeStrategy
を返します。setSessionAttributePredicate
WebSession
属性の抽出に使用する述語を構成し、使用して WebSocket セッションを初期化します。デフォルトでは、これは設定されていません。この場合、属性は渡されません。
- パラメーター:
predicate
- 述語- 導入:
- 5.1
getSessionAttributePredicate
WebSession
属性から初期化 WebSocket セッション属性用に構成された述語を返します。- 導入:
- 5.1
start
public void start()インターフェースからコピーされた説明:Lifecycle
このコンポーネントを起動します。コンポーネントがすでに実行されている場合は、例外をスローしないでください。
コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。
doStart
protected void doStart()stop
public void stop()インターフェースからコピーされた説明:Lifecycle
このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle
とそのstop(Runnable)
バリアントの実装を検討してください。この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、
Lifecycle
Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止シグナルを事前に考慮することなく呼び出されます。コンポーネントが実行されていない(まだ開始されていない)場合は、例外をスローしないでください。
コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。
doStop
protected void doStop()isRunning
public boolean isRunning()インターフェースからコピーされた説明:Lifecycle
このコンポーネントが現在実行されているかどうかを確認します。コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、
true
を返します。handleRequest
public reactor.core.publisher.Mono<VoidSE> handleRequest(ServerWebExchange exchange, WebSocketHandler handler) インターフェースからコピーされた説明:WebSocketService
指定されたWebSocketHandler
でリクエストを処理します。- 次で指定:
- インターフェース
WebSocketService
のhandleRequest
- パラメーター:
exchange
- 現在の交換handler
- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッションのアプリケーション処理が完了すると完了する
Mono<Void>
。