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 Uhrzeit in UTC, bis zu der die Sitzung gesperrt ist. Jedes Mal, wenn renewSessionLock() aufgerufen wird, wird diese Zeit auf die aktuelle Zeit und die Sperrdauer aktualisiert, die während der Erstellung der Warteschlange/des Abonnements angegeben wurde. Gibt undefiniert zurück, bis ein AMQP-Empfängerlink erfolgreich für die Sitzung eingerichtet wurde.

Geerbte Eigenschaften

entityPath	Pfad der Entität, für die der Empfänger erstellt wurde.
identifier	Ein Name, der zur Identifizierung des Empfängers verwendet wird. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges generiert.
isClosed	Gibt zurück true , wenn entweder der Empfänger oder der Client, von dem er erstellt wurde, 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 Sitzungsstatus.
renewSessionLock(OperationOptionsBase)	Erneuert die Sperre für die Sitzung.
setSessionState(any, OperationOptionsBase)	Legt den Zustand für die Sitzung fest. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungsstatus.
subscribe(MessageHandlers, SubscribeOptions)	Streamen von Nachrichten an Nachrichtenhandler.

Geerbte Methoden

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Die vom Empfänger für die Nachricht gehaltene Sperre wird losgelassen, sodass die Nachricht in Service Bus für einen anderen Empfangsvorgang wieder 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 den 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 Unzustellbare Unterwarteschlange. Um eine Unzustellbare Nachricht zu erhalten, erstellen Sie einen neuen QueueClient/SubscriptionClient mithilfe des Pfads für die Unzustellbare Unterwarteschlange.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Verzögert die Verarbeitung der Nachricht. Speichern Sie die sequenceNumber der Nachricht, um die Nachricht 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)	Sehen Sie sich den nächsten Batch aktiver Nachrichten (einschließlich verzögerter, aber nicht unzustellbare Nachrichten) in der Warteschlange oder dem Abonnement an, ohne sie zu ändern. Der erste Aufruf von ruft peekMessages() die erste aktive Nachricht ab. Jeder nachfolgende Aufruf ruft die nachfolgende Nachricht ab. Im Gegensatz zu einer "empfangenen" Nachricht ist die "eingesehene" Nachricht eine schreibgeschützte Version der Nachricht. Diese darf nicht Completed/Abandoned/Deferred/Deadlettered sein.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Gibt eine Zusage zurück, die in ein Array verzögerter Nachrichten aufgelöst wird, die durch den angegebenen 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, die während der Erstellung der Warteschlange/des Abonnements angegeben wurde. Überprüfen Sie die lockedUntilUtc Eigenschaft der Nachricht auf den Zeitpunkt, zu dem die Sperre abläuft. Wenn eine Nachricht nicht abgerechnet wird (entweder , 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 Uhrzeit in UTC, bis zu der die Sitzung gesperrt ist. Jedes Mal, wenn renewSessionLock() aufgerufen wird, wird diese Zeit auf die aktuelle Zeit und die Sperrdauer aktualisiert, die während der Erstellung der Warteschlange/des Abonnements angegeben wurde.

Gibt undefiniert zurück, bis ein AMQP-Empfängerlink erfolgreich für die Sitzung 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 zur Identifizierung des Empfängers verwendet wird. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges generiert.

identifier: string

Eigenschaftswert

string

Geerbt vonServiceBusReceiver.identifier

isClosed

Gibt zurück true , wenn entweder der Empfänger oder der Client, von dem er erstellt wurde, 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 Sitzungsstatus.

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

Parameter

options

OperationOptionsBase

Optionsbeutel, um ein Abbruchsignal oder Ablaufverfolgungsoptionen zu übergeben.

Gibt zurück

Promise<any>

Der Zustand 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 Zustand für die Sitzung fest. Weitere Informationen zu Sitzungszuständen finden Sie unter Sitzungsstatus.

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

Parameter

state

any

Der Zustand, der festgelegt werden muss.

options

OperationOptionsBase

Optionsbeutel, um ein Abbruchsignal oder Ablaufverfolgungsoptionen zu übergeben.

Gibt zurück

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Streamen von 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 das Abonnieren.

Gibt zurück

{ close() => Promise<void> }

Ein -Objekt, das geschlossen werden kann, das alle verbleibenden Nachrichten an handlers sendet und das Eintreffen neuer Nachrichten beendet.

Details zur geerbten Methode

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

Die vom Empfänger für die Nachricht gehaltene Sperre wird losgelassen, sodass die Nachricht in Service Bus für einen anderen Empfangsvorgang wieder 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 soll.

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 den 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 Unzustellbare Unterwarteschlange. Um eine Unzustellbare Nachricht zu erhalten, erstellen Sie einen neuen QueueClient/SubscriptionClient mithilfe des Pfads für die Unzustellbare 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 die Nachricht 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 Nachricht, die beim Zurückstellen der Nachricht geändert werden soll

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 verwendet werden soll, um den laufenden Vorgang abzubrechen.

Gibt zurück

AsyncIterableIterator<ServiceBusReceivedMessage>

Geerbt vonServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Sehen Sie sich den nächsten Batch aktiver Nachrichten (einschließlich verzögerter, aber nicht unzustellbare Nachrichten) in der Warteschlange oder dem Abonnement an, ohne sie zu ändern.

• Der erste Aufruf von ruft peekMessages() die erste aktive Nachricht ab. Jeder nachfolgende Aufruf ruft die nachfolgende Nachricht ab.
• Im Gegensatz zu einer "empfangenen" Nachricht ist die "eingesehene" Nachricht eine schreibgeschützte Version der Nachricht. Diese darf nicht Completed/Abandoned/Deferred/Deadlettered sein.

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 angegeben werden kann, die einSehen erfolgen soll, die sequenceNumber, von der aus ein Vorschauvorgang gestartet werden soll, oder ein Abbruchsignal 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 den angegebenen 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

Optionsbeutel, um ein Abbruchsignal oder Ablaufverfolgungsoptionen zu übergeben.

Gibt zurück

Promise<ServiceBusReceivedMessage[]>

Eine Liste von Nachrichten, die von den angegebenen sequenceNumbers identifiziert werden, oder eine leere Liste, 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 von Nachrichten, die empfangen werden sollen.

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 verwendet werden soll, um den laufenden Vorgang abzubrechen.

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, die während der Erstellung der Warteschlange/des Abonnements angegeben wurde.

• Überprüfen Sie die lockedUntilUtc Eigenschaft der Nachricht auf den Zeitpunkt, zu dem die Sperre abläuft.
• Wenn eine Nachricht nicht abgerechnet wird (entweder , 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>

Datum und Uhrzeit des Neuen Sperrtokenablaufs im UTC-Format.

Geerbt vonServiceBusReceiver.renewMessageLock