次の方法で共有

SubscribeOptions interface

  • リファレンス
パッケージ:
@azure/service-bus

Service Bus キューまたはサブスクリプションをサブスクライブするときに使用されるオプション。

Extends
OperationOptionsBase

プロパティ

autoCompleteMessages

ユーザーが指定 processMessage したコールバックの結果に基づいて、メッセージを自動的に解決するかどうかを示します。

  • コールバックから processMessage エラーがスローされた場合、メッセージは を使用して receiver.abandonMessage()破棄されます。 これにより、キュー/サブスクリプションからメッセージが再び使用可能になり、配信数が増加します。
  • NO エラーがスローされた processMessage 場合、メッセージは を使用して receiver.completeMessage()完了します。 これにより、キュー/サブスクリプションからメッセージが削除されます。

このオプションは、メッセージが受信モードで receiveAndDelete 受信された場合、またはメッセージがユーザー指定のメッセージ コールバックで既に解決されている場合は無視されます。

  • 既定値: true。
maxConcurrentCalls

ライブラリがユーザーのメッセージ ハンドラーに対して行うことができる同時呼び出しの最大数。 この制限に達すると、ユーザーのメッセージ ハンドラーへの呼び出しの少なくとも 1 つが完了するまで、さらに多くのメッセージを受信できなくなります。

  • 既定値: 1。

継承されたプロパティ

abortSignal

要求を中止するために使用できるシグナル。
tracingOptions

トレースが有効な場合に使用されるオプション。

プロパティの詳細

autoCompleteMessages

ユーザーが指定 processMessage したコールバックの結果に基づいて、メッセージを自動的に解決するかどうかを示します。

  • コールバックから processMessage エラーがスローされた場合、メッセージは を使用して receiver.abandonMessage()破棄されます。 これにより、キュー/サブスクリプションからメッセージが再び使用可能になり、配信数が増加します。
  • NO エラーがスローされた processMessage 場合、メッセージは を使用して receiver.completeMessage()完了します。 これにより、キュー/サブスクリプションからメッセージが削除されます。

このオプションは、メッセージが受信モードで receiveAndDelete 受信された場合、またはメッセージがユーザー指定のメッセージ コールバックで既に解決されている場合は無視されます。

  • 既定値: true。
autoCompleteMessages?: boolean

プロパティ値

boolean

maxConcurrentCalls

ライブラリがユーザーのメッセージ ハンドラーに対して行うことができる同時呼び出しの最大数。 この制限に達すると、ユーザーのメッセージ ハンドラーへの呼び出しの少なくとも 1 つが完了するまで、さらに多くのメッセージを受信できなくなります。

  • 既定値: 1。
maxConcurrentCalls?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

継承元 OperationOptionsBase.abortSignal

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元 OperationOptionsBase.tracingOptions