EventHubConsumerClient.ReadEventsFromPartitionAsync Methode

Definition

Namespace:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Paket:

Azure.Messaging.EventHubs v5.11.3

Überlädt

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 sind, und wartet bei Bedarf darauf, dass keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum blockiert await werden, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass der Abbruch über das cancellationToken angefordert werden muss, um die Steuerung zurückzugeben. Es wird empfohlen, die Überladung aufzurufen, die eine Reihe von Optionen zum Konfigurieren des Leseverhaltens für Szenarien akzeptiert, in denen eine deterministische maximale Wartezeit gewünscht wird.

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 sind, und wartet bei Bedarf darauf, dass keine Ereignisse verfügbar sind. Dieser Enumerator kann für einen unbestimmten Zeitraum blockiert await werden, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass der Abbruch über das cancellationToken angefordert werden muss, um die Steuerung zurückzugeben. Es wird empfohlen, die MaximumWaitTime für Szenarien festzulegen, in denen eine deterministische maximale Wartezeit gewünscht wird.

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Quelle:

EventHubConsumerClient.cs

Liest Ereignisse aus der angeforderten Partition als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar sind, und wartet bei Bedarf darauf, dass keine Ereignisse verfügbar sind.

Dieser Enumerator kann für einen unbestimmten Zeitraum blockiert await werden, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass der Abbruch über das cancellationToken angefordert werden muss, um die Steuerung zurückzugeben. Es wird empfohlen, die Überladung aufzurufen, die eine Reihe von Optionen zum Konfigurieren des Leseverhaltens für Szenarien akzeptiert, in denen eine deterministische maximale Wartezeit gewünscht wird.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>

Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

Parameter

partitionId

String

Der Bezeichner der Event Hub-Partition, von der Ereignisse empfangen werden.

startingPosition

EventPosition

Die Position innerhalb der Partition, an der der Consumer mit dem Lesen von Ereignissen beginnen soll.

cancellationToken

CancellationToken

Ein optionaler CancellationToken instance, um der Anforderung zu signalisieren, den Vorgang abzubrechen.

Gibt zurück

IAsyncEnumerable<PartitionEvent>

Ein IAsyncEnumerable<T> , der zum Durchlaufen von Ereignissen in der Partition verwendet werden soll.

Ausnahmen

EventHubsException

Tritt auf, wenn ein EventHubConsumerClient nicht aus der angeforderten Event Hub-Partition lesen kann, weil ein anderer Leser den exklusiven Besitz bestätigt hat. In diesem Fall wird auf EventHubsException.FailureReason festgelegt ConsumerDisconnected.

Hinweise

Jeder Leser von Ereignissen wird mit einem unabhängigen Iterator präsentiert; Wenn mehrere Leser vorhanden sind, erhält jeder seine eigene Kopie eines zu verarbeitenden Ereignisses, anstatt um sie zu konkurrieren.

Weitere Informationen

• ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Quelle:

EventHubConsumerClient.cs

Liest Ereignisse aus der angeforderten Partition als asynchrone Aufzählung, sodass Ereignisse durchlaufen werden können, sobald sie auf der Partition verfügbar sind, und wartet bei Bedarf darauf, dass keine Ereignisse verfügbar sind.

Dieser Enumerator kann für einen unbestimmten Zeitraum blockiert await werden, wenn Ereignisse auf der Partition nicht verfügbar sind, sodass der Abbruch über das cancellationToken angefordert werden muss, um die Steuerung zurückzugeben. Es wird empfohlen, die MaximumWaitTime für Szenarien festzulegen, in denen eine deterministische maximale Wartezeit gewünscht wird.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>

Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

Parameter

partitionId

String

Der Bezeichner der Event Hub-Partition, von der Ereignisse empfangen werden.

startingPosition

EventPosition

Die Position innerhalb der Partition, an der der Consumer mit dem Lesen von Ereignissen beginnen soll.

readOptions

ReadEventOptions

Der Satz von Optionen, die zum Konfigurieren des Leseverhaltens verwendet werden sollen; wenn nicht angegeben, werden die Standardwerte verwendet.

cancellationToken

CancellationToken

Ein optionaler CancellationToken instance, um der Anforderung zu signalisieren, den Vorgang abzubrechen.

Gibt zurück

IAsyncEnumerable<PartitionEvent>

Ein IAsyncEnumerable<T> , der zum Durchlaufen von Ereignissen in der Partition verwendet werden soll.

Ausnahmen

EventHubsException

Tritt auf, wenn ein EventHubConsumerClient nicht aus der angeforderten Event Hub-Partition lesen kann, weil ein anderer Leser den exklusiven Besitz bestätigt hat. In diesem Fall wird auf EventHubsException.FailureReason festgelegt ConsumerDisconnected.

Hinweise

Jeder Leser von Ereignissen wird mit einem unabhängigen Iterator präsentiert; Wenn mehrere Leser vorhanden sind, erhält jeder seine eigene Kopie eines zu verarbeitenden Ereignisses, anstatt um sie zu konkurrieren.

Weitere Informationen

• ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)