インターフェース StompSession
- すべての既知のサブインターフェース:
ConnectionHandlingStompSession
- すべての既知の実装クラス:
DefaultStompSession
public interface StompSession
メッセージを送信し、サブスクリプションを作成し、それらのサブスクリプションでメッセージを受信する操作を含む STOMP セッションを表します。
- 導入:
- 4.2
- 作成者:
- Rossen Stoyanchev
ネストされたクラスのサマリー
修飾子と型インターフェース説明static interface
領収書を追跡するために使用するハンドル。static interface
退会または領収書の追跡に使用するハンドル。メソッドのサマリー
修飾子と型メソッド説明acknowledge
(StringSE messageId, boolean consumed) メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。acknowledge
(StompHeaders headers, boolean consumed) void
DISCONNECT フレームを送信してセッションを切断します。void
disconnect
(StompHeaders headers) ヘッダー付きのdisconnect()
の変種。セッションの ID を返します。boolean
セッションが接続されているかどうか。MessageConverter
を使用してペイロードをbyte[]
に変換し、指定された宛先にメッセージを送信します。send
(StompHeaders headers, ObjectSE payload) 宛先だけではなく、完全なStompHeaders
を備えたsend(String, Object)
のオーバーロードバージョン。void
setAutoReceipt
(boolean enabled) 有効にすると、このセッションの今後のsend
およびsubscribe
操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。subscribe
(StringSE destination, StompFrameHandler handler) SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定されたStompFrameHandler
で受信メッセージを処理します。subscribe
(StompHeaders headers, StompFrameHandler handler) 宛先だけではなく、完全なStompHeaders
を備えたsubscribe(String, StompFrameHandler)
のオーバーロードバージョン。
メソッドの詳細
getSessionId
StringSE getSessionId()セッションの ID を返します。isConnected
boolean isConnected()セッションが接続されているかどうか。setAutoReceipt
void setAutoReceipt(boolean enabled) 有効にすると、このセッションの今後のsend
およびsubscribe
操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。アプリケーションは、操作から返されたReceiptable
を使用して、領収書を追跡できます。StompHeaders
を受け入れるオーバーロードされたメソッドを使用して、受信ヘッダーを手動で追加することもできます。send
MessageConverter
を使用してペイロードをbyte[]
に変換し、指定された宛先にメッセージを送信します。- パラメーター:
destination
- メッセージの送信先payload
- メッセージペイロード- 戻り値:
- 領収書を追跡するための Receiptable
send
宛先だけではなく、完全なStompHeaders
を備えたsend(String, Object)
のオーバーロードバージョン。ヘッダーには宛先が含まれている必要があり、ブローカーがサブスクライバーに伝搬するための「コンテンツ型」やカスタムヘッダーなどの他のヘッダー、またはブローカー固有の非標準ヘッダーが含まれる場合もあります。- パラメーター:
headers
- メッセージヘッダーpayload
- メッセージペイロード- 戻り値:
- 領収書を追跡するための Receiptable
subscribe
SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定されたStompFrameHandler
で受信メッセージを処理します。- パラメーター:
destination
- 購読する宛先handler
- 受信したメッセージのハンドラー- 戻り値:
- 領収書の登録解除および / または追跡に使用するハンドル
subscribe
宛先だけではなく、完全なStompHeaders
を備えたsubscribe(String, StompFrameHandler)
のオーバーロードバージョン。- パラメーター:
headers
- サブスクライブされたメッセージフレームのヘッダーhandler
- 受信したメッセージのハンドラー- 戻り値:
- 領収書の登録解除および / または追跡に使用するハンドル
acknowledge
メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。注意 : サブスクライブするときにこれを使用するには、これを使用するために、
ack
ヘッダーを "client" または "client-individual" に設定する必要があります。- パラメーター:
messageId
- メッセージの IDconsumed
- メッセージが消費されたかどうか- 戻り値:
- 領収書を追跡するための Receiptable
- 導入:
- 4.3
acknowledge
- パラメーター:
headers
- ACK または NACK メッセージフレームのヘッダーconsumed
- メッセージが消費されたかどうか- 戻り値:
- 領収書を追跡するための Receiptable
- 導入:
- 5.0.5
disconnect
void disconnect()DISCONNECT フレームを送信してセッションを切断します。disconnect
ヘッダー付きのdisconnect()
の変種。- パラメーター:
headers
- 切断メッセージフレームのヘッダー- 導入:
- 5.2.2