クラス DefaultStompSession

メソッドの詳細

• getSessionId

  public StringSE getSessionId()

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の getSessionId 

  次で指定:

  インターフェース StompTcpConnectionHandler<byte[]> の getSessionId 

• getConnectHeaders

  public StompHeaderAccessor getConnectHeaders()

  インターフェースからコピーされた説明: StompTcpConnectionHandler

  STOMPCONNECT フレームで送信されるヘッダーを返します。

  次で指定:

  インターフェース StompTcpConnectionHandler<byte[]> の getConnectHeaders 

• getSessionHandler

  public StompSessionHandler getSessionHandler()

  設定されたセッションハンドラーを返します。

• getSession

  public CompletableFutureSE<StompSession> getSession()

  インターフェースからコピーされた説明: ConnectionHandlingStompSession

  セッションが使用可能になったときに完了するフューチャーを返します。

  次で指定:

  インターフェース ConnectionHandlingStompSession の getSession 

• setMessageConverter

  public void setMessageConverter(MessageConverter messageConverter)

  オブジェクト型または予期されるオブジェクト型と "content-type" ヘッダーに基づいて、受信メッセージと発信メッセージのペイロードを byte[] との間で変換するために使用する MessageConverter を設定します。

  デフォルトでは、SimpleMessageConverter が構成されています。

  パラメーター:

  messageConverter - 使用するメッセージコンバーター

• getMessageConverter

  public MessageConverter getMessageConverter()

  設定された MessageConverter を返します。

• setTaskScheduler

  public void setTaskScheduler(@Nullable TaskScheduler taskScheduler)

  領収書の追跡に使用する TaskScheduler を構成します。

• getTaskScheduler

  @Nullable public TaskScheduler getTaskScheduler()

  構成済みの TaskScheduler を受け取り、レシート追跡に使用します。

• setReceiptTimeLimit

  public void setReceiptTimeLimit(long receiptTimeLimit)

  レシートが期限切れになるまでの時間をミリ秒単位で構成します。

  デフォルトでは 15,000 (15 秒に設定されています）。

• getReceiptTimeLimit

  public long getReceiptTimeLimit()

  レシートの有効期限が切れる前に、構成された制限時間を返します。

• setAutoReceipt

  public void setAutoReceipt(boolean autoReceiptEnabled)

  インターフェースからコピーされた説明: StompSession

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

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

  次で指定:

  インターフェース StompSession の setAutoReceipt 

• isAutoReceiptEnabled

  public boolean isAutoReceiptEnabled()

  受信ヘッダーを自動的に追加するかどうか。

• isConnected

  public boolean isConnected()

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の isConnected 

• send

  public StompSession.Receiptable send(StringSE destination, ObjectSE payload)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の send 

  パラメーター:

  destination - メッセージの送信先

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

  戻り値:

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

• send

  public StompSession.Receiptable send(StompHeaders headers, ObjectSE payload)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の send 

  パラメーター:

  headers - メッセージヘッダー

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

  戻り値:

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

• subscribe

  public StompSession.Subscription subscribe(StringSE destination, StompFrameHandler handler)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の subscribe 

  パラメーター:

  destination - 購読する宛先

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

  戻り値:

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

• subscribe

  public StompSession.Subscription subscribe(StompHeaders headers, StompFrameHandler handler)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の subscribe 

  パラメーター:

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

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

  戻り値:

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

• acknowledge

  public StompSession.Receiptable acknowledge(StringSE messageId, boolean consumed)

  インターフェースからコピーされた説明: StompSession

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

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

  次で指定:

  インターフェース StompSession の acknowledge 

  パラメーター:

  messageId - メッセージの ID

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

  戻り値:

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

• acknowledge

  public StompSession.Receiptable acknowledge(StompHeaders headers, boolean consumed)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の acknowledge 

  パラメーター:

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

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

  戻り値:

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

• disconnect

  public void disconnect()

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の disconnect 

• disconnect

  public void disconnect(@Nullable StompHeaders headers)

  インターフェースからコピーされた説明: StompSession

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

  次で指定:

  インターフェース StompSession の disconnect 

  パラメーター:

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

• afterConnected

  public void afterConnected(TcpConnection<byte[]> connection)

  インターフェースからコピーされた説明: TcpConnectionHandler

  接続が正常に確立された後に呼び出されます。

  次で指定:

  インターフェース TcpConnectionHandler<byte[]> の afterConnected 

  パラメーター:

  connection - 接続

• afterConnectFailure

  public void afterConnectFailure(ThrowableSE ex)

  インターフェースからコピーされた説明: TcpConnectionHandler

  接続に失敗したときに呼び出されます。

  次で指定:

  インターフェース TcpConnectionHandler<byte[]> の afterConnectFailure 

  パラメーター:

  ex - 例外

• handleMessage

  public void handleMessage(Message<byte[]> message)

  インターフェースからコピーされた説明: TcpConnectionHandler

  リモートホストから受信したメッセージを処理します。

  次で指定:

  インターフェース TcpConnectionHandler<byte[]> の handleMessage 

  パラメーター:

  message - メッセージ

• handleFailure

  public void handleFailure(ThrowableSE ex)

  インターフェースからコピーされた説明: TcpConnectionHandler

  接続の失敗を処理します。

  次で指定:

  インターフェース TcpConnectionHandler<byte[]> の handleFailure 

  パラメーター:

  ex - 例外

• afterConnectionClosed

  public void afterConnectionClosed()

  インターフェースからコピーされた説明: TcpConnectionHandler

  接続が閉じた後に呼び出されます。

  次で指定:

  インターフェース TcpConnectionHandler<byte[]> の afterConnectionClosed