Freigeben über


ServiceBusSessionReceiverOptions interface

Beschreibt die Optionen, die an die acceptSession Methoden und acceptNextSession übergeben werden, wenn eine Warteschlange/ein Abonnement verwendet wird, für das Sitzungen aktiviert sind.

Extends

Eigenschaften

identifier

Legt den Namen fest, um den Sitzungsempfänger zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges verwendet.

maxAutoLockRenewalDurationInMs

Die maximale Dauer in Millisekunden, die die Sperre für die Sitzung automatisch vom Client verlängert wird.

  • Standard: 300000 Millisekunden (5 Minuten).
  • Um die Verlängerung des automatischen Sperrens zu deaktivieren, legen Sie dies auf fest 0.

Beispiel:

Wenn die Sperre in 2 Minuten abläuft und Ihre Verarbeitungszeit 8 Minuten beträgt...

Legen Sie maxAutoLockRenewalDurationInMs auf 10 Minuten fest, und die Sperre wird etwa 4 Mal automatisch erneuert (entspricht der Sperre für das 4-fache ihrer Sperrdauer durch Nutzung der Sperrverlängerungen).

receiveMode

Stellt den Empfangsmodus für den Empfänger dar.

Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.

Im peekLock-Modus verfügt der Empfänger über eine Sperre für die Nachricht für die für die Warteschlange/das Abonnement angegebene Dauer.

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange/das Abonnement festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet.

Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen.

Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

skipConvertingDate

Gibt an, ob die Konvertierung des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfang der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden Eigenschaften des Datumstyps aus Kompatibilitätsgründen in die UNIX-Epochennummer konvertiert.

skipParsingBodyAsJson

Option zum Deaktivieren der Ausführung von JSON.parse() für den Client im Nachrichtentext beim Empfang der Nachricht. Gilt nicht, wenn die Nachricht mit dem Wert oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den bytes zu arbeiten, die im Nachrichtentext vorhanden sind, als dass der Client versucht, sie zu analysieren.

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

identifier

Legt den Namen fest, um den Sitzungsempfänger zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges verwendet.

identifier?: string

Eigenschaftswert

string

maxAutoLockRenewalDurationInMs

Die maximale Dauer in Millisekunden, die die Sperre für die Sitzung automatisch vom Client verlängert wird.

  • Standard: 300000 Millisekunden (5 Minuten).
  • Um die Verlängerung des automatischen Sperrens zu deaktivieren, legen Sie dies auf fest 0.

Beispiel:

Wenn die Sperre in 2 Minuten abläuft und Ihre Verarbeitungszeit 8 Minuten beträgt...

Legen Sie maxAutoLockRenewalDurationInMs auf 10 Minuten fest, und die Sperre wird etwa 4 Mal automatisch erneuert (entspricht der Sperre für das 4-fache ihrer Sperrdauer durch Nutzung der Sperrverlängerungen).

maxAutoLockRenewalDurationInMs?: number

Eigenschaftswert

number

receiveMode

Stellt den Empfangsmodus für den Empfänger dar.

Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.

Im peekLock-Modus verfügt der Empfänger über eine Sperre für die Nachricht für die für die Warteschlange/das Abonnement angegebene Dauer.

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange/das Abonnement festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet.

Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen.

Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Eigenschaftswert

"peekLock" | "receiveAndDelete"

skipConvertingDate

Gibt an, ob die Konvertierung des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfang der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden Eigenschaften des Datumstyps aus Kompatibilitätsgründen in die UNIX-Epochennummer konvertiert.

skipConvertingDate?: boolean

Eigenschaftswert

boolean

skipParsingBodyAsJson

Option zum Deaktivieren der Ausführung von JSON.parse() für den Client im Nachrichtentext beim Empfang der Nachricht. Gilt nicht, wenn die Nachricht mit dem Wert oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den bytes zu arbeiten, die im Nachrichtentext vorhanden sind, als dass der Client versucht, sie zu analysieren.

skipParsingBodyAsJson?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

Geerbt von OperationOptionsBase.abortSignal

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

Geerbt von OperationOptionsBase.tracingOptions