クラス org.springframework.messaging.simp.stomp.StompHeaders の使用 (Spring Framework API)

StompHeaders を使用するパッケージ
パッケージ	説明
org.springframework.messaging.simp.stomp	シンプルなメッセージングプロトコル（STOMP など）の一般的なサポート。
org.springframework.web.socket.messaging	Spring のメッセージングモジュール用の WebSocket 統合。

org.springframework.messaging.simp.stomp 内の StompHeaders 使用

StompHeaders を返す org.springframework.messaging.simp.stomp のメソッド
修飾子と型	メソッドと説明
`StompHeaders`	StompSession.Subscription.`getSubscriptionHeaders()` SUBSCRIBE フレームで使用されているヘッダーを返します。
`protected StompHeaders`	StompClientSupport.`processConnectHeaders(StompHeaders connectHeaders)` StompHeaders をさらに初期化します。たとえば、必要に応じてハートビートヘッダーを設定します。
`static StompHeaders`	StompHeaders.`readOnlyStompHeaders(MapSE<StringSE, ListSE<StringSE>> headers)` 読み取りのみが可能で、書き込みはできない `StompHeaders` オブジェクトを返します。

型 StompHeaders のパラメーターを持つ org.springframework.messaging.simp.stomp のメソッド
修飾子と型	メソッドと説明
`StompSession.Receiptable`	StompSession.`acknowledge(StompHeaders headers, boolean consumed)` `messageId` だけでなく、完全な `StompHeaders` を備えた `StompSession.acknowledge(String, boolean)` のオーバーロードバージョン。
`StompSession.Receiptable`	DefaultStompSession.`acknowledge(StompHeaders headers, boolean consumed)`
`void`	StompSessionHandler.`afterConnected(StompSession session, StompHeaders connectedHeaders)` セッションが使用できる状態になったときに呼び出されます。
`void`	StompSessionHandlerAdapter.`afterConnected(StompSession session, StompHeaders connectedHeaders)` この実装は空です。
`ListenableFuture<StompSession>`	ReactorNettyTcpStompClient.`connect(StompHeaders connectHeaders, StompSessionHandler handler)` STOMP CONNECT フレームに使用するヘッダーを受け入れるオーバーロードバージョンの `ReactorNettyTcpStompClient.connect(StompSessionHandler)`。
`protected ConnectionHandlingStompSession`	StompClientSupport.`createSession(StompHeaders connectHeaders, StompSessionHandler handler)` 新しいセッションを作成および構成するためのファクトリメソッド。
`void`	StompSession.`disconnect(StompHeaders headers)` ヘッダー付きの `StompSession.disconnect()` の変種。
`void`	DefaultStompSession.`disconnect(StompHeaders headers)`
`TypeSE`	StompFrameHandler.`getPayloadType(StompHeaders headers)` `StompFrameHandler.handleFrame(StompHeaders, Object)` の前に呼び出され、ペイロードが変換されるオブジェクトの型を決定します。
`TypeSE`	StompSessionHandlerAdapter.`getPayloadType(StompHeaders headers)` この実装は、STOMP ERROR フレームの予想されるペイロード型として文字列を返します。
`void`	StompSessionHandler.`handleException(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, ThrowableSE exception)` ペイロードの変換の失敗やアプリケーション `StompFrameHandler` の未処理の例外など、STOMP フレームの処理中に発生した例外を処理します。
`void`	StompSessionHandlerAdapter.`handleException(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, ThrowableSE exception)` この実装は空です。
`void`	StompFrameHandler.`handleFrame(StompHeaders headers, ObjectSE payload)` `StompFrameHandler.getPayloadType(StompHeaders)` から返されたターゲット型に変換されたペイロードで STOMP フレームを処理します。
`void`	StompSessionHandlerAdapter.`handleFrame(StompHeaders headers, ObjectSE payload)` この実装は空です。
`protected StompHeaders`	StompClientSupport.`processConnectHeaders(StompHeaders connectHeaders)` StompHeaders をさらに初期化します。たとえば、必要に応じてハートビートヘッダーを設定します。
`StompSession.Receiptable`	StompSession.`send(StompHeaders headers, ObjectSE payload)` 宛先だけではなく、完全な `StompHeaders` を備えた `StompSession.send(String, Object)` のオーバーロードバージョン。
`StompSession.Receiptable`	DefaultStompSession.`send(StompHeaders headers, ObjectSE payload)`
`StompSession.Subscription`	StompSession.`subscribe(StompHeaders headers, StompFrameHandler handler)` 宛先だけではなく、完全な `StompHeaders` を備えた `StompSession.subscribe(String, StompFrameHandler)` のオーバーロードバージョン。
`StompSession.Subscription`	DefaultStompSession.`subscribe(StompHeaders headers, StompFrameHandler handler)`
`void`	StompSession.Subscription.`unsubscribe(StompHeaders headers)` サーバーに送信する追加のカスタムヘッダーを持つ `StompSession.Subscription.unsubscribe()` の代替。

型 StompHeaders の型引数を持つ org.springframework.messaging.simp.stomp のメソッドパラメーター
修飾子と型	メソッドと説明
`void`	StompSession.Receiptable.`addReceiptTask(ConsumerSE<StompHeaders> task)` `RECEIPT` フレームからのヘッダーの `Consumer`SE を持つ `StompSession.Receiptable.addReceiptTask(Runnable)` のバリアント。

型 StompHeaders のパラメーターを持つ org.springframework.messaging.simp.stomp のコンストラクター
コンストラクターと説明
`DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)` 新しいセッションを作成します。

org.springframework.web.socket.messaging 内の StompHeaders 使用

StompHeaders を返す org.springframework.web.socket.messaging のメソッド
修飾子と型	メソッドと説明
`protected StompHeaders`	WebSocketStompClient.`processConnectHeaders(StompHeaders connectHeaders)`

型 StompHeaders のパラメーターを持つ org.springframework.web.socket.messaging のメソッド
修飾子と型	メソッドと説明
`ListenableFuture<StompSession>`	WebSocketStompClient.`connect(StringSE url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, ObjectSE... uriVariables)` `WebSocketStompClient.connect(String, StompSessionHandler, Object...)` のオーバーロードバージョン。`WebSocketHttpHeaders` を WebSocket ハンドシェイクに使用し、`StompHeaders` を STOMP CONNECT フレームに使用することもできます。
`ListenableFuture<StompSession>`	WebSocketStompClient.`connect(URISE url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler)` 完全に準備された `URI`SE を受け入れるオーバーロードバージョンの `WebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)`。
`protected StompHeaders`	WebSocketStompClient.`processConnectHeaders(StompHeaders connectHeaders)`

クラスの使用 org.springframework.messaging.simp.stomp.StompHeaders

org.springframework.messaging.simp.stomp 内の StompHeaders 使用

org.springframework.web.socket.messaging 内の StompHeaders 使用

クラスの使用
org.springframework.messaging.simp.stomp.StompHeaders