ServiceBusReceiver Klasse

Referenz

Definition

Namespace:: Azure.Messaging.ServiceBus

Assembly:: Azure.Messaging.ServiceBus.dll

Paket:: Azure.Messaging.ServiceBus v7.17.5

Source:: ServiceBusReceiver.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Der ServiceBusReceiver ist für den Empfang und das ServiceBusReceivedMessage Abgleichen von Nachrichten von Warteschlangen und Abonnements verantwortlich. Sie wird durch Aufrufen CreateReceiver(String, ServiceBusReceiverOptions)von erstellt.

public class ServiceBusReceiver : IAsyncDisposable

type ServiceBusReceiver = class
    interface IAsyncDisposable

Public Class ServiceBusReceiver
Implements IAsyncDisposable

Vererbung: Object
ServiceBusReceiver

Abgeleitet: Azure.Messaging.ServiceBus.ServiceBusSessionReceiver

Implementiert: IAsyncDisposable

Hinweise

Kann ServiceBusReceiver sicher zwischengespeichert und verwendet werden, während der Lebensdauer einer Anwendung oder bis die, von der ServiceBusClient sie erstellt wurde, verworfen wird. Das Zwischenspeichern des Empfängers wird empfohlen, wenn die Anwendung regelmäßig oder halb regelmäßig Nachrichten verwendet. Der Empfänger ist dafür verantwortlich, eine effiziente Netzwerk-, CPU- und Arbeitsspeichernutzung sicherzustellen. Das Aufrufen DisposeAsync() des zugeordneten ServiceBusClient beim Herunterfahren der Anwendung stellt sicher, dass Netzwerkressourcen und andere nicht verwaltete Objekte, die vom Empfänger verwendet werden, ordnungsgemäß bereinigt werden.

Konstruktoren

ServiceBusReceiver()	Initialisiert eine neue instance der -Klasse für die ServiceBusReceiver Simulation.
ServiceBusReceiver(ServiceBusClient, String, ServiceBusReceiverOptions)	Initialisiert einen neuen instance der ServiceBusReceiver -Klasse zur Verwendung mit abgeleiteten Typen.
ServiceBusReceiver(ServiceBusClient, String, String, ServiceBusReceiverOptions)	Initialisiert einen neuen instance der ServiceBusReceiver -Klasse zur Verwendung mit abgeleiteten Typen.

Eigenschaften

EntityPath	Der Pfad der Service Bus-Entität, mit der der Empfänger verbunden ist, spezifisch für den Service Bus-Namespace, der ihn enthält.
FullyQualifiedNamespace	Der vollqualifizierte Service Bus-Namespace, dem der Empfänger zugeordnet ist. Dies ist wahrscheinlich ähnlich wie .`{yournamespace}.servicebus.windows.net`
Identifier	Ein Name, der zum Identifizieren des Empfängerclients verwendet wird. Wenn `null` oder leer, wird ein zufälliger eindeutiger Wert verwendet.
IsClosed	Gibt an, ob diese ServiceBusReceiver geschlossen wurde.
PrefetchCount	Die Anzahl der Nachrichten, die eifrig von Warteschlangen oder Abonnements angefordert und lokal in die Warteschlange gestellt werden, ohne zu berücksichtigen, ob eine Verarbeitung derzeit aktiv ist, soll dazu beitragen, den Durchsatz zu maximieren, indem der Empfänger aus einem lokalen Cache empfangen kann, anstatt auf eine Dienstanforderung zu warten.
ReceiveMode	Der ReceiveMode , der verwendet wird, um anzugeben, wie Nachrichten empfangen werden.

Methoden

AbandonMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Gibt ein auf ServiceBusReceivedMessage. Dadurch wird die Nachricht wieder zur sofortigen Verarbeitung zur Verfügung gestellt, da die Sperre für die nachricht, die vom Empfänger gespeichert ist, aufgehoben wird.
CloseAsync(CancellationToken)	Führt die Aufgabe aus, die zum sauber von ServiceBusReceiververwendeten Ressourcen erforderlich ist.
CompleteMessageAsync(ServiceBusReceivedMessage, CancellationToken)	Schließt eine ab ServiceBusReceivedMessage. Dadurch wird die Nachricht aus dem Dienst gelöscht.
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Verschiebt eine Nachricht in die Unterwarteschlange für unzustellbare Nachrichten.
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, String, String, CancellationToken)	Verschiebt eine Nachricht in die Unterwarteschlange für unzustellbare Nachrichten.
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)	Verschiebt eine Nachricht in die Unterwarteschlange für unzustellbare Nachrichten.
DeferMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Gibt an, dass der Empfänger die Verarbeitung der Nachricht zurückstellen möchte.
DisposeAsync()	Führt die Aufgabe aus, die zum sauber von ServiceBusReceiververwendeten Ressourcen erforderlich ist. Dies entspricht dem Aufrufen von CloseAsync(CancellationToken).
PeekMessageAsync(Nullable<Int64>, CancellationToken)	Ruft den nächsten aktiven ServiceBusReceivedMessage Ab, ohne den Status des Empfängers oder der Nachrichtenquelle zu ändern.
PeekMessagesAsync(Int32, Nullable<Int64>, CancellationToken)	Der ServiceBusReceiver ist für den Empfang und das ServiceBusReceivedMessage Abgleichen von Nachrichten von Warteschlangen und Abonnements verantwortlich. Sie wird durch Aufrufen CreateReceiver(String, ServiceBusReceiverOptions)von erstellt.
ReceiveDeferredMessageAsync(Int64, CancellationToken)	Empfängt eine verzögerte Nachricht, die durch identifiziert wird `sequenceNumber`.
ReceiveDeferredMessagesAsync(IEnumerable<Int64>, CancellationToken)	Empfängt eine Liste von verzögerten Nachrichten, die durch identifiziert werden `sequenceNumbers`.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Empfängt eine ServiceBusReceivedMessage von der Entität mithilfe ReceiveMode des Modus. ReceiveMode wird standardmäßig auf PeekLock-Modus festgelegt.
ReceiveMessagesAsync(CancellationToken)	Empfängt Nachrichten als asynchrone Enumerable von der Entität im ReceiveMode Modus. ReceiveMode wird standardmäßig auf PeekLock-Modus festgelegt. Nachrichten werden von der Entität empfangen, wenn IAsyncEnumerable durchlaufen wird. Wenn keine Nachrichten verfügbar sind, wird von dieser Methode weiterhin abgerufen, bis Nachrichten verfügbar sind, d. h. sie gibt nie NULL zurück.
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	Empfängt eine Liste von ServiceBusReceivedMessage von der Entität, die den Modus verwendet ReceiveMode . ReceiveMode wird standardmäßig auf PeekLock-Modus festgelegt. Diese Methode garantiert nicht, dass genaue `maxMessages` Nachrichten zurückgegeben werden, auch wenn in der Warteschlange oder dem Thema Nachrichten verfügbar sind `maxMessages` .
RenewMessageLockAsync(ServiceBusReceivedMessage, CancellationToken)	Erneuert die Sperre für die Nachricht. Die Sperre wird basierend auf der in der Warteschlange angegebenen Einstellung verlängert.

Gilt für: