public interface StompSession| 修飾子と型 | インターフェースと説明 |
|---|---|
static interface | StompSession.Receiptable 領収書を追跡するために使用するハンドル。 |
static interface | StompSession.Subscription 退会または領収書の追跡に使用するハンドル。 |
| 修飾子と型 | メソッドと説明 |
|---|---|
StompSession.Receiptable | acknowledge(StringSE messageId, boolean consumed) メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。 |
void | disconnect()DISCONNECT フレームを送信してセッションを切断します。 |
StringSE | getSessionId() セッションの ID を返します。 |
boolean | isConnected() セッションが接続されているかどうか。 |
StompSession.Receiptable | send(StompHeaders headers, ObjectSE payload) 宛先の代わりに完全な StompHeaders を受け入れる send(String, Object) のオーバーロードバージョン。 |
StompSession.Receiptable | send(StringSE destination, ObjectSE payload)MessageConverter を使用してペイロードを byte[] に変換し、指定された宛先にメッセージを送信します。 |
void | setAutoReceipt(boolean enabled) 有効にすると、このセッションの今後の send および subscribe 操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。 |
StompSession.Subscription | subscribe(StompHeaders headers, StompFrameHandler handler) 宛先の代わりに完全な StompHeaders を受け入れる subscribe(String, StompFrameHandler) のオーバーロードバージョン。 |
StompSession.Subscription | subscribe(StringSE destination, StompFrameHandler handler)SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定された StompFrameHandler で受信メッセージを処理します。 |
StringSE getSessionId()
boolean isConnected()
void setAutoReceipt(boolean enabled)
send および subscribe 操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。アプリケーションは、操作から返された Receiptable を使用して、領収書を追跡できます。StompHeaders を受け入れるオーバーロードされたメソッドを使用して、受信ヘッダーを手動で追加することもできます。
StompSession.Receiptable send(StringSE destination, ObjectSE payload)
MessageConverter を使用してペイロードを byte[] に変換し、指定された宛先にメッセージを送信します。destination - メッセージの送信先 payload - メッセージペイロード StompSession.Receiptable send(StompHeaders headers, ObjectSE payload)
StompHeaders を受け入れる send(String, Object) のオーバーロードバージョン。ヘッダーには宛先が含まれている必要があり、ブローカーがサブスクライバーに伝搬するための "content-type" やカスタムヘッダー、またはブローカー固有の非標準ヘッダーなどの他のヘッダーが含まれている場合もあります。headers - メッセージヘッダー payload - メッセージペイロード StompSession.Subscription subscribe(StringSE destination, StompFrameHandler handler)
StompFrameHandler で受信メッセージを処理します。destination - 購読する宛先 handler - 受信したメッセージのハンドラー StompSession.Subscription subscribe(StompHeaders headers, StompFrameHandler handler)
StompHeaders を受け入れる subscribe(String, StompFrameHandler) のオーバーロードバージョン。headers - サブスクライブメッセージフレームのヘッダー handler - 受信したメッセージのハンドラー StompSession.Receiptable acknowledge(StringSE messageId, boolean consumed)
注意 : サブスクライブするときにこれを使用するには、これを使用するために、ack ヘッダーを "client" または "client-individual" に設定する必要があります。
messageId - メッセージの IDconsumed - メッセージが消費されたかどうか void disconnect()