Freigeben über


ServiceBusSessionReceiverOptions interface

Beschreibt die Optionen, die an die acceptSession und acceptNextSession Methoden übergeben werden, wenn sie eine Warteschlange/ein Abonnement verwenden, für die 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 sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert verwendet.

maxAutoLockRenewalDurationInMs

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

  • Standard-: 300000 Millisekunden (5 Minuten).
  • Wenn Sie die Verlängerung der automatischen Sperredeaktivieren möchten, legen Sie dies auf 0fest.

Beispiel:

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

Legen Sie "maxAutoLockRenewalDurationInMs" auf 10 Minuten fest, und die Sperre wird ca. 4 Mal verlängert (entspricht der 4-fachen Sperrdauer der Sitzung durch Nutzung der Sperrverlängerungen).

receiveMode

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

Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

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

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die maximale Anzahl der Zustellungen in der Warteschlange/im Abonnement zurückgesetzt, nach der sie an eine separate Warteschlange für inaktive Briefe gesendet werden.

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

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

skipConvertingDate

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

skipParsingBodyAsJson

Option zum Deaktivieren des Clients beim Empfang der Nachricht vom Ausführen von JSON.parse() im Nachrichtentext. Nicht zutreffend, wenn die Nachricht mit DEM AMQP-Texttypwert oder -sequenz gesendet wurde. Verwenden Sie diese Option, wenn Sie lieber direkt mit den Im Nachrichtentext vorhandenen Bytes arbeiten möchten, 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 sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert verwendet.

identifier?: string

Eigenschaftswert

string

maxAutoLockRenewalDurationInMs

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

  • Standard-: 300000 Millisekunden (5 Minuten).
  • Wenn Sie die Verlängerung der automatischen Sperredeaktivieren möchten, legen Sie dies auf 0fest.

Beispiel:

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

Legen Sie "maxAutoLockRenewalDurationInMs" auf 10 Minuten fest, und die Sperre wird ca. 4 Mal verlängert (entspricht der 4-fachen Sperrdauer der Sitzung durch Nutzung der Sperrverlängerungen).

maxAutoLockRenewalDurationInMs?: number

Eigenschaftswert

number

receiveMode

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

Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

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

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die maximale Anzahl der Zustellungen in der Warteschlange/im Abonnement zurückgesetzt, nach der sie an eine separate Warteschlange für inaktive Briefe gesendet werden.

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

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Eigenschaftswert

"peekLock" | "receiveAndDelete"

skipConvertingDate

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

skipConvertingDate?: boolean

Eigenschaftswert

boolean

skipParsingBodyAsJson

Option zum Deaktivieren des Clients beim Empfang der Nachricht vom Ausführen von JSON.parse() im Nachrichtentext. Nicht zutreffend, wenn die Nachricht mit DEM AMQP-Texttypwert oder -sequenz gesendet wurde. Verwenden Sie diese Option, wenn Sie lieber direkt mit den Im Nachrichtentext vorhandenen Bytes arbeiten möchten, 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

von OperationOptionsBase.abortSignal geerbt

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

von OperationOptionsBase.tracingOptions geerbt