ServiceBusSessionReceiver interface

Paket:

@azure/service-bus

Ein Empfänger, der Sitzungen verarbeitet, einschließlich der Verlängerung der Sitzungssperre.

Extends

ServiceBusReceiver

Eigenschaften

sessionId	Die Sitzungs-ID.
sessionLockedUntilUtc	Die Zeit in UTC, bis die Sitzung gesperrt ist. Jedes Mal, wenn renewSessionLock() aufgerufen wird, wird diese Zeit auf die aktuelle Uhrzeit und die Sperrdauer aktualisiert, wie während der Warteschlangen-/Abonnementerstellung angegeben. Gibt nicht definiert zurück, bis ein AMQP-Empfängerlink für die Sitzung erfolgreich eingerichtet wurde.

Geerbte Eigenschaften

entityPath	Pfad der Entität, für die der Empfänger erstellt wurde.
identifier	Ein Name, der zum Identifizieren des Empfängers verwendet wird. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert.
isClosed	Gibt true zurück, wenn der Empfänger oder der Client, der ihn erstellt hat, geschlossen wurde.
receiveMode	Der Empfangsmodus, der zum Erstellen des Empfängers verwendet wird.

Methoden

getSessionState(OperationOptionsBase)	Ruft den Status der Sitzung ab. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungszustand
renewSessionLock(OperationOptionsBase)	Erneuert die Sperre für die Sitzung.
setSessionState(any, OperationOptionsBase)	Legt den Status für die Sitzung fest. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungszustand
subscribe(MessageHandlers, SubscribeOptions)	Streamt Nachrichten an Nachrichtenhandler.

Geerbte Methoden

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Die Sperre, die vom Empfänger an der Nachricht gehalten wird, wird losgelassen, sodass die Nachricht wieder in Service Bus für einen anderen Empfangsvorgang verfügbar ist.
close()	Schließt den Empfänger. Nach dem Schließen kann der Empfänger nicht mehr für weitere Vorgänge verwendet werden. Verwenden Sie die createReceiver()-Methode für serviceBusClient, um einen neuen Empfänger zu erstellen.
completeMessage(ServiceBusReceivedMessage)	Entfernt die Nachricht aus service bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Verschiebt die Nachricht in die Unterwarteschlange des Deadletters. Um eine Sacklettnachricht zu erhalten, erstellen Sie einen neuen QueueClient/SubscriptionClient mit dem Pfad für die Deadletter-Unterwarteschlange.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Verzögert die Verarbeitung der Nachricht. Speichern Sie die sequenceNumber der Nachricht, um sie in Zukunft mit der receiveDeferredMessage-Methode erneut zu empfangen.
getMessageIterator(GetMessageIteratorOptions)	Gibt einen Iterator zurück, der zum Empfangen von Nachrichten von Service Bus verwendet werden kann.
peekMessages(number, PeekMessagesOptions)	Werfen Sie einen Blick auf den nächsten Batch aktiver Nachrichten (einschließlich verzögerter, aber nicht inaktiver Nachrichten) in der Warteschlange oder im Abonnement, ohne sie zu ändern. Der erste Aufruf von peekMessages() ruft die erste aktive Nachricht ab. Jeder nachfolgende Aufruf ruft die nachfolgende Nachricht ab. Im Gegensatz zu einer "empfangenen" Nachricht ist die "Vorschau"-Nachricht eine schreibgeschützte Version der Nachricht. Es kann nicht Completed/Abandoned/Deferred/Deadletteredwerden.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Gibt eine Zusage zurück, die in ein Array verzögerter Nachrichten aufgelöst wird, die durch die angegebene sequenceNumbersidentifiziert werden.
receiveMessages(number, ReceiveMessagesOptions)	Gibt eine Zusage zurück, die in ein Array von Nachrichten aufgelöst wird, die von Service Bus empfangen wurden.
renewMessageLock(ServiceBusReceivedMessage)	Erneuert die Sperre für die Nachricht für die Dauer, wie während der Erstellung der Warteschlange/des Abonnements angegeben. Überprüfen Sie die lockedUntilUtc Eigenschaft für die Nachricht, wann die Sperre abläuft. Wenn eine Nachricht nicht abgeschlossen ist (entweder mit complete(), defer() oder deadletter(), bevor die Sperre abläuft, landet die Nachricht wieder in der Warteschlange/im Abonnement für den nächsten Empfangsvorgang.

Details zur Eigenschaft

sessionId

Die Sitzungs-ID.

sessionId: string

Eigenschaftswert

string

sessionLockedUntilUtc

Die Zeit in UTC, bis die Sitzung gesperrt ist. Jedes Mal, wenn renewSessionLock() aufgerufen wird, wird diese Zeit auf die aktuelle Uhrzeit und die Sperrdauer aktualisiert, wie während der Warteschlangen-/Abonnementerstellung angegeben.

Gibt nicht definiert zurück, bis ein AMQP-Empfängerlink für die Sitzung erfolgreich eingerichtet wurde.

sessionLockedUntilUtc: Date

Eigenschaftswert

Date

Geerbte Eigenschaftsdetails

entityPath

Pfad der Entität, für die der Empfänger erstellt wurde.

entityPath: string

Eigenschaftswert

string

geerbt vonServiceBusReceiver.entityPath

identifier

Ein Name, der zum Identifizieren des Empfängers verwendet wird. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert.

identifier: string

Eigenschaftswert

string

vonServiceBusReceiver.identifier geerbt

isClosed

Gibt true zurück, wenn der Empfänger oder der Client, der ihn erstellt hat, geschlossen wurde.

isClosed: boolean

Eigenschaftswert

boolean

geerbt vonServiceBusReceiver.isClosed

receiveMode

Der Empfangsmodus, der zum Erstellen des Empfängers verwendet wird.

receiveMode: "peekLock" | "receiveAndDelete"

Eigenschaftswert

"peekLock" | "receiveAndDelete"

Geerbt vonServiceBusReceiver.receiveMode

Details zur Methode

getSessionState(OperationOptionsBase)

Ruft den Status der Sitzung ab. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungszustand

function getSessionState(options?: OperationOptionsBase): Promise<any>

Parameter

options

OperationOptionsBase

Optionsbehälter zum Übergeben von Abbruchsignal- oder Ablaufverfolgungsoptionen.

Gibt zurück

Promise<any>

Der Status dieser Sitzung

renewSessionLock(OperationOptionsBase)

Erneuert die Sperre für die Sitzung.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

Parameter

options

OperationOptionsBase

Gibt zurück

Promise<Date>

setSessionState(any, OperationOptionsBase)

Legt den Status für die Sitzung fest. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungszustand

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

Parameter

state

any

Der Zustand, der festgelegt werden muss.

options

OperationOptionsBase

Optionsbehälter zum Übergeben von Abbruchsignal- oder Ablaufverfolgungsoptionen.

Gibt zurück

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Streamt Nachrichten an Nachrichtenhandler.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Parameter

handlers

MessageHandlers

Ein Handler, der für Nachrichten und Fehler aufgerufen wird.

options

SubscribeOptions

Optionen für abonniert.

Gibt zurück

{ close() => Promise<void> }

Ein Objekt, das geschlossen werden kann und alle verbleibenden Nachrichten an handlers sendet und neue Nachrichten nicht mehr eintrifft.

Details zur geerbten Methode

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Die Sperre, die vom Empfänger an der Nachricht gehalten wird, wird losgelassen, sodass die Nachricht wieder in Service Bus für einen anderen Empfangsvorgang verfügbar ist.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Die Eigenschaften der Nachricht, die beim Verlassen der Nachricht geändert werden sollen.

Gibt zurück

Promise<void>

Geerbt vonServiceBusReceiver.abandonMessage

close()

Schließt den Empfänger. Nach dem Schließen kann der Empfänger nicht mehr für weitere Vorgänge verwendet werden. Verwenden Sie die createReceiver()-Methode für serviceBusClient, um einen neuen Empfänger zu erstellen.

function close(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Entfernt die Nachricht aus service bus.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

Parameter

message

ServiceBusReceivedMessage

Gibt zurück

Promise<void>

Geerbt vonServiceBusReceiver.completeMessage

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

Verschiebt die Nachricht in die Unterwarteschlange des Deadletters. Um eine Sacklettnachricht zu erhalten, erstellen Sie einen neuen QueueClient/SubscriptionClient mit dem Pfad für die Deadletter-Unterwarteschlange.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parameter

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

Die DeadLetter-Optionen, die beim Ablehnen der Nachricht bereitgestellt werden können.

Gibt zurück

Promise<void>

geerbt vonServiceBusReceiver.deadLetterMessage

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Verzögert die Verarbeitung der Nachricht. Speichern Sie die sequenceNumber der Nachricht, um sie in Zukunft mit der receiveDeferredMessage-Methode erneut zu empfangen.

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Die Eigenschaften der Zu ändernden Nachricht beim Zurückstellen der Nachricht

Gibt zurück

Promise<void>

Geerbt vonServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Gibt einen Iterator zurück, der zum Empfangen von Nachrichten von Service Bus verwendet werden kann.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

Parameter

options

GetMessageIteratorOptions

Eine Reihe von Optionen zum Steuern des Empfangsvorgangs.

• abortSignal: Das Signal, das zum Abbrechen des laufenden Vorgangs verwendet werden soll.

Gibt zurück

AsyncIterableIterator<ServiceBusReceivedMessage>

Geerbt vonServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Werfen Sie einen Blick auf den nächsten Batch aktiver Nachrichten (einschließlich verzögerter, aber nicht inaktiver Nachrichten) in der Warteschlange oder im Abonnement, ohne sie zu ändern.

• Der erste Aufruf von peekMessages() ruft die erste aktive Nachricht ab. Jeder nachfolgende Aufruf ruft die nachfolgende Nachricht ab.
• Im Gegensatz zu einer "empfangenen" Nachricht ist die "Vorschau"-Nachricht eine schreibgeschützte Version der Nachricht. Es kann nicht Completed/Abandoned/Deferred/Deadletteredwerden.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parameter

maxMessageCount

number

Die maximale Anzahl von Nachrichten, die angezeigt werden sollen.

options

PeekMessagesOptions

Optionen, mit denen die maximale Anzahl von Nachrichten angezeigt werden kann, die sequenceNumber zum Starten des Vorschauvorgangs oder eines AbortSignals zum Abbrechen des Vorgangs.

Gibt zurück

Promise<ServiceBusReceivedMessage[]>

geerbt vonServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Gibt eine Zusage zurück, die in ein Array verzögerter Nachrichten aufgelöst wird, die durch die angegebene sequenceNumbersidentifiziert werden.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

Parameter

sequenceNumbers

Long | Long[]

Die Sequenznummer oder ein Array von Sequenznummern für die Nachrichten, die empfangen werden müssen.

options

OperationOptionsBase

Optionsbehälter zum Übergeben von Abbruchsignal- oder Ablaufverfolgungsoptionen.

Gibt zurück

Promise<ServiceBusReceivedMessage[]>

Eine Liste von Nachrichten, die durch die angegebene SequenceNumbers oder eine leere Liste identifiziert werden, wenn keine Nachrichten gefunden werden.

Geerbt vonServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Gibt eine Zusage zurück, die in ein Array von Nachrichten aufgelöst wird, die von Service Bus empfangen wurden.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parameter

maxMessageCount

number

Die maximale Anzahl der empfangenden Nachrichten.

options

ReceiveMessagesOptions

Eine Reihe von Optionen zum Steuern des Empfangsvorgangs.

• maxWaitTimeInMs: Die maximale Wartezeit für die erste Nachricht, bevor ein leeres Array zurückgegeben wird, wenn keine Nachrichten verfügbar sind.
• abortSignal: Das Signal, das zum Abbrechen des laufenden Vorgangs verwendet werden soll.

Gibt zurück

Promise<ServiceBusReceivedMessage[]>

Eine Zusage, die mit einem Array von Nachrichten aufgelöst wird.

Geerbt vonServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Erneuert die Sperre für die Nachricht für die Dauer, wie während der Erstellung der Warteschlange/des Abonnements angegeben.

• Überprüfen Sie die lockedUntilUtc Eigenschaft für die Nachricht, wann die Sperre abläuft.
• Wenn eine Nachricht nicht abgeschlossen ist (entweder mit complete(), defer() oder deadletter(), bevor die Sperre abläuft, landet die Nachricht wieder in der Warteschlange/im Abonnement für den nächsten Empfangsvorgang.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

Parameter

message

ServiceBusReceivedMessage

Gibt zurück

Promise<Date>

Neues Ablaufdatum und -uhrzeit des Sperrtokens im UTC-Format.

Geerbt vonServiceBusReceiver.renewMessageLock