Freigeben über


PartitionReceiver.ReceiveBatchAsync Methode

Definition

Überlädt

ReceiveBatchAsync(Int32, CancellationToken)

Empfängt einen Batch von EventData von der Event Hub-Partition, der diesem Client zugeordnet ist.

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

Empfängt einen Batch von EventData von der Event Hub-Partition, der diesem Client zugeordnet ist.

ReceiveBatchAsync(Int32, CancellationToken)

Quelle:
PartitionReceiver.cs
Quelle:
PartitionReceiver.cs

Empfängt einen Batch von EventData von der Event Hub-Partition, der diesem Client zugeordnet ist.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, System.Threading.CancellationToken cancellationToken = default);
abstract member ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

Parameter

maximumEventCount
Int32

Die maximale Anzahl von Nachrichten, die in diesem Batch empfangen werden sollen.

cancellationToken
CancellationToken

Ein optionaler CancellationToken instance, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren.

Gibt zurück

Der Batch von EventData aus der Event Hub-Partition, mit der dieser Client verknüpft ist. Wenn keine Ereignisse vorhanden sind, wird eine leere Aufzählung zurückgegeben.

Ausnahmen

Tritt auf, wenn die angeforderte maximumEventCount kleiner als 1 ist.

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

Hinweise

Wenn Ereignisse in der Prefetch-Warteschlange verfügbar sind, werden sie verwendet, um den Batch so schnell wie möglich zu bilden, ohne auf zusätzliche Ereignisse aus dem Event Hubs-Dienst zu warten, um zu versuchen, die angeforderten maximumEventCountzu erfüllen. Wenn im Prefetch keine Ereignisse verfügbar sind, wartet der Empfänger bis zur in TryTimeout der aktiven Wiederholungsrichtlinie angegebenen Dauer, bis Ereignisse aus dem Dienst gelesen werden. Sobald alle Ereignisse verfügbar sind, werden sie verwendet, um den Batch sofort zu bilden.

Gilt für:

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

Quelle:
PartitionReceiver.cs
Quelle:
PartitionReceiver.cs

Empfängt einen Batch von EventData von der Event Hub-Partition, der diesem Client zugeordnet ist.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, TimeSpan maximumWaitTime, System.Threading.CancellationToken cancellationToken = default);
abstract member ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, maximumWaitTime As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

Parameter

maximumEventCount
Int32

Die maximale Anzahl von Nachrichten, die in diesem Batch empfangen werden sollen.

maximumWaitTime
TimeSpan

Die maximale Wartezeit, bis Ereignisse verfügbar werden, wenn keine Ereignisse aus der Prefetch-Warteschlange gelesen werden können.

cancellationToken
CancellationToken

Ein optionaler CancellationToken instance, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren.

Gibt zurück

Der Batch von EventData aus der Event Hub-Partition, mit der dieser Client verknüpft ist. Wenn keine Ereignisse vorhanden sind, wird eine leere Aufzählung zurückgegeben.

Ausnahmen

Tritt auf, wenn die angeforderte maximumEventCount kleiner als 1 ist.

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

Hinweise

Wenn Ereignisse in der Prefetch-Warteschlange verfügbar sind, werden sie verwendet, um den Batch so schnell wie möglich zu bilden, ohne auf zusätzliche Ereignisse aus dem Event Hubs-Dienst zu warten, um zu versuchen, die angeforderten maximumEventCountzu erfüllen. Wenn im Prefetch keine Ereignisse verfügbar sind, wartet der Empfänger bis zu dem maximumWaitTime , bis Ereignisse aus dem Dienst gelesen werden. Sobald alle Ereignisse verfügbar sind, werden sie verwendet, um den Batch sofort zu bilden.

Gilt für: