EventHubConsumerClient Klasse

Definition

Namespace:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Paket:

Azure.Messaging.EventHubs v5.11.3

Quelle:

EventHubConsumerClient.cs

Ein Client, der für das Lesen EventData aus einem bestimmten Event Hub als Mitglied einer bestimmten Consumergruppe verantwortlich ist.

Ein Consumer kann exklusiv sein, wodurch der Besitz über zugeordnete Partitionen für die Consumergruppe geltend gemacht wird, um sicherzustellen, dass nur ein Consumer aus dieser Gruppe die aus der Partition liest. Diese exklusiven Verbraucher werden manchmal als "Epoch Consumer" bezeichnet.

Ein Consumer kann auch nicht exklusiv sein, sodass mehrere Consumer aus derselben Consumergruppe Ereignisse aus einer bestimmten Partition aktiv lesen können. Diese nicht exklusiven Verbraucher werden manchmal als "Non-Epoch Consumer" bezeichnet.

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

Vererbung

Object

EventHubConsumerClient

Implementiert

IAsyncDisposable

Hinweise

Die EventHubConsumerClient ist sicher, während der Lebensdauer einer Anwendung zwischenzuspeichern und zu verwenden. Dies ist die bewährte Methode, wenn die Anwendung Ereignisse regelmäßig oder halb regelmäßig liest. Der Consumer ist dafür verantwortlich, eine effiziente Netzwerk-, CPU- und Arbeitsspeichernutzung sicherzustellen. Wenn Sie entweder CloseAsync(CancellationToken) oder DisposeAsync() aufrufen, während die Anwendung heruntergefahren wird, wird sichergestellt, dass Netzwerkressourcen und andere nicht verwaltete Objekte ordnungsgemäß bereinigt werden.

Konstruktoren

EventHubConsumerClient()	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, EventHubConnection, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, String)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, String, AzureNamedKeyCredential, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, String, AzureSasCredential, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, String, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.
EventHubConsumerClient(String, String, String, TokenCredential, EventHubConsumerClientOptions)	Initialisiert eine neue Instanz der EventHubConsumerClient-Klasse.

Felder

DefaultConsumerGroupName

Der Name der Standard-Consumergruppe im Event Hubs-Dienst.

Eigenschaften

ConsumerGroup	Der Name der Consumergruppe, der dieser Consumer zugeordnet ist. Ereignisse werden im Kontext dieser Gruppe schreibgeschützt.
EventHubName	Der Name des Event Hubs, mit dem der Consumer verbunden ist, spezifisch für den Event Hubs-Namespace, der ihn enthält.
FullyQualifiedNamespace	Der vollqualifizierte Event Hubs-Namespace, dem der Consumer zugeordnet ist. Dies ist wahrscheinlich ähnlich wie .{yournamespace}.servicebus.windows.net
Identifier	Ein eindeutiger Name, der zum Identifizieren dieses Consumers verwendet wird.
IsClosed	Gibt an, ob diese EventHubConsumerClient geschlossen wurde oder nicht.

Methoden

CloseAsync(CancellationToken)	Schließt den Consumer.
DisposeAsync()	Führt die Aufgabe aus, die zum sauber von verwendeten Ressourcen erforderlich ist, einschließlich der EventHubConsumerClientSicherstellung, dass der Client selbst geschlossen wurde.
GetEventHubPropertiesAsync(CancellationToken)	Ruft Informationen zum Event Hub ab, dem die Verbindung zugeordnet ist, einschließlich der Anzahl der vorhandenen Partitionen und deren Bezeichner.
GetPartitionIdsAsync(CancellationToken)	Ruft den Satz von Bezeichnern für die Partitionen eines Event Hubs ab.
GetPartitionPropertiesAsync(String, CancellationToken)	Ruft Informationen zu einer bestimmten Partition für einen Event Hub ab, einschließlich Elementen, die die verfügbaren Ereignisse im Partitionsereignisstream beschreiben.
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	Liest Ereignisse aus allen Partitionen des Event Hubs als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar werden, und wartet bei Bedarf, falls keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum für einen await blockieren, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass die Abbruch über die angefordert werden muss, um die cancellationToken Kontrolle zurückzugeben. Es wird empfohlen, für MaximumWaitTime Szenarien festzulegen, in denen eine deterministischere maximale Wartezeit gewünscht wird.
ReadEventsAsync(CancellationToken)	Liest Ereignisse aus allen Partitionen des Event Hubs als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar werden, und wartet bei Bedarf, falls keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum für einen await blockieren, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass die Abbruch über die angefordert werden muss, um die cancellationToken Kontrolle zurückzugeben. Es wird empfohlen, für MaximumWaitTime Szenarien festzulegen, in denen eine deterministischere maximale Wartezeit gewünscht wird.
ReadEventsAsync(ReadEventOptions, CancellationToken)	Liest Ereignisse aus allen Partitionen des Event Hubs als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar werden, und wartet bei Bedarf, falls keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum für einen await blockieren, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass die Abbruch über die angefordert werden muss, um die cancellationToken Kontrolle zurückzugeben. Es wird empfohlen, für MaximumWaitTime Szenarien festzulegen, in denen eine deterministischere maximale Wartezeit gewünscht wird.
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	Liest Ereignisse aus der angeforderten Partition als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar werden, und wartet bei Bedarf, wenn keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum für einen await blockieren, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass die Abbruch über die angefordert werden muss, um die cancellationToken Kontrolle zurückzugeben. Es wird empfohlen, die Überladung aufzurufen, die eine Reihe von Optionen zum Konfigurieren des Leseverhaltens für Szenarien akzeptiert, in denen eine deterministischere maximale Wartezeit gewünscht ist.
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	Liest Ereignisse aus der angeforderten Partition als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar werden, und wartet bei Bedarf, wenn keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum für einen await blockieren, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass die Abbruch über die angefordert werden muss, um die cancellationToken Kontrolle zurückzugeben. Es wird empfohlen, für MaximumWaitTime Szenarien festzulegen, in denen eine deterministischere maximale Wartezeit gewünscht wird.