PartitionReceiver.ReceiveBatchAsync Méthode

Définition

Espace de noms:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Paquet:

Azure.Messaging.EventHubs v5.11.6

Surcharges

ReceiveBatchAsync(Int32, CancellationToken)	Reçoit un lot de EventData de la partition Event Hub à laquelle ce client est associé.
ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)	Reçoit un lot de EventData de la partition Event Hub à laquelle ce client est associé.

ReceiveBatchAsync(Int32, CancellationToken)

Source:

PartitionReceiver.cs

Reçoit un lot de EventData de la partition Event Hub à laquelle ce client est associé.

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))

Paramètres

maximumEventCount

Int32

Nombre maximal de messages à recevoir dans ce lot.

cancellationToken

CancellationToken

Une instance facultative CancellationToken pour signaler la demande d’annulation de l’opération.

Retours

Task<IEnumerable<EventData>>

Lot de EventData de la partition Event Hub à laquelle ce client est associé. Si aucun événement n’est présent, un énumérable vide est retourné.

Exceptions

ArgumentOutOfRangeException

Se produit lorsque la valeur demandée maximumEventCount est inférieure à 1.

EventHubsException

Se produit lorsqu’un PartitionReceiver ne peut pas lire à partir de la partition Event Hub demandée en raison d’un autre lecteur ayant affirmé la propriété exclusive. Dans ce cas, le EventHubsException.FailureReason est défini sur ConsumerDisconnected.

Remarques

Lorsque des événements sont disponibles dans la file d’attente de prérécupération, ils sont utilisés pour former le lot aussi rapidement que possible sans attendre que d’autres événements du service Event Hubs essaient de répondre à la demande maximumEventCount. Lorsqu’aucun événement n’est disponible en prérécupération, le récepteur attend jusqu’à la durée spécifiée par dans TryTimeout la stratégie de nouvelle tentative active pour que les événements soient lus à partir du service. Une fois que tous les événements sont disponibles, ils sont utilisés pour former le lot immédiatement.

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

Source:

PartitionReceiver.cs

Reçoit un lot de EventData de la partition Event Hub à laquelle ce client est associé.

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))

Paramètres

maximumEventCount

Int32

Nombre maximal de messages à recevoir dans ce lot.

maximumWaitTime

TimeSpan

Durée maximale d’attente avant la disponibilité des événements, si aucun événement ne peut être lu à partir de la file d’attente de prérécupération.

cancellationToken

CancellationToken

Une instance facultative CancellationToken pour signaler la demande d’annulation de l’opération.

Retours

Task<IEnumerable<EventData>>

Lot de EventData de la partition Event Hub à laquelle ce client est associé. Si aucun événement n’est présent, un énumérable vide est retourné.

Exceptions

ArgumentOutOfRangeException

Se produit lorsque la valeur demandée maximumEventCount est inférieure à 1.

EventHubsException

Se produit lorsqu’un PartitionReceiver ne peut pas lire à partir de la partition Event Hub demandée en raison d’un autre lecteur ayant affirmé la propriété exclusive. Dans ce cas, le EventHubsException.FailureReason est défini sur ConsumerDisconnected.

Remarques

Lorsque des événements sont disponibles dans la file d’attente de prérécupération, ils sont utilisés pour former le lot aussi rapidement que possible sans attendre que d’autres événements du service Event Hubs essaient de répondre à la demande maximumEventCount. Lorsqu’aucun événement n’est disponible en prérécupération, le récepteur attend jusqu’à ce que les maximumWaitTime événements soient lus à partir du service. Une fois que tous les événements sont disponibles, ils sont utilisés pour former le lot immédiatement.