インターフェース StompSession

メソッドの詳細

• getSessionId

  StringSE getSessionId()

  セッションの ID を返します。

• isConnected

  boolean isConnected()

  セッションが接続されているかどうか。

• setAutoReceipt

  void setAutoReceipt(boolean enabled)

  有効にすると、このセッションの今後の send および subscribe 操作に受信ヘッダーが自動的に追加され、サーバーが RECEIPT を返します。アプリケーションは、操作から返された Receiptable を使用して、領収書を追跡できます。

  StompHeaders を受け入れるオーバーロードされたメソッドを使用して、受信ヘッダーを手動で追加することもできます。

• send

  StompSession.Receiptable send(StringSE destination, ObjectSE payload)

  MessageConverter を使用してペイロードを byte[] に変換し、指定された宛先にメッセージを送信します。

  パラメーター:

  destination - メッセージの送信先

  payload - メッセージペイロード

  戻り値:

  領収書を追跡するための Receiptable

• send

  StompSession.Receiptable send(StompHeaders headers, ObjectSE payload)

  宛先だけではなく、完全な StompHeaders を備えた send(String, Object) のオーバーロードバージョン。ヘッダーには宛先が含まれている必要があり、ブローカーがサブスクライバーに伝搬するための「コンテンツ型」やカスタムヘッダーなどの他のヘッダー、またはブローカー固有の非標準ヘッダーが含まれる場合もあります。

  パラメーター:

  headers - メッセージヘッダー

  payload - メッセージペイロード

  戻り値:

  領収書を追跡するための Receiptable

• subscribe

  StompSession.Subscription subscribe(StringSE destination, StompFrameHandler handler)

  SUBSCRIBE フレームを送信して所定の宛先にサブスクライブし、指定された StompFrameHandler で受信メッセージを処理します。

  パラメーター:

  destination - 購読する宛先

  handler - 受信したメッセージのハンドラー

  戻り値:

  領収書の登録解除および / または追跡に使用するハンドル

• subscribe

  StompSession.Subscription subscribe(StompHeaders headers, StompFrameHandler handler)

  宛先だけではなく、完全な StompHeaders を備えた subscribe(String, StompFrameHandler) のオーバーロードバージョン。

  パラメーター:

  headers - サブスクライブされたメッセージフレームのヘッダー

  handler - 受信したメッセージのハンドラー

  戻り値:

  領収書の登録解除および / または追跡に使用するハンドル

• acknowledge

  StompSession.Receiptable acknowledge(StringSE messageId, boolean consumed)

  メッセージが消費されたかどうかにかかわらず、それぞれ ACK または NACK フレームを生成する確認応答を送信します。

  注意 : サブスクライブするときにこれを使用するには、これを使用するために、ack ヘッダーを "client" または "client-individual" に設定する必要があります。

  パラメーター:

  messageId - メッセージの ID

  consumed - メッセージが消費されたかどうか

  戻り値:

  領収書を追跡するための Receiptable

  導入:

  4.3

• acknowledge

  StompSession.Receiptable acknowledge(StompHeaders headers, boolean consumed)

  messageId だけでなく、完全な StompHeaders を備えた acknowledge(String, boolean) のオーバーロードバージョン。

  パラメーター:

  headers - ACK または NACK メッセージフレームのヘッダー

  consumed - メッセージが消費されたかどうか

  戻り値:

  領収書を追跡するための Receiptable

  導入:

  5.0.5

• disconnect

  void disconnect()

  DISCONNECT フレームを送信してセッションを切断します。

• disconnect

  void disconnect(StompHeaders headers)

  ヘッダー付きの disconnect() の変種。

  パラメーター:

  headers - 切断メッセージフレームのヘッダー

  導入:

  5.2.2