EventHubConsumerClient.ReadEventsFromPartitionAsync Méthode

Définition

Espace de noms:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Paquet:

Azure.Messaging.EventHubs v5.11.3

Surcharges

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé d’appeler la surcharge qui accepte un ensemble d’options pour configurer le comportement de lecture pour les scénarios où une période d’attente maximale plus déterministe est souhaitée.

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Source:

EventHubConsumerClient.cs

Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible.

Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé d’appeler la surcharge qui accepte un ensemble d’options pour configurer le comportement de lecture pour les scénarios où une période d’attente maximale plus déterministe est souhaitée.

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)

Paramètres

partitionId

String

Identificateur de la partition Event Hub à partir de laquelle les événements seront reçus.

startingPosition

EventPosition

Position dans la partition où le consommateur doit commencer à lire les événements.

cancellationToken

CancellationToken

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

Retours

IAsyncEnumerable<PartitionEvent>

IAsyncEnumerable<T> à utiliser pour l’itération sur les événements dans la partition.

Exceptions

EventHubsException

Se produit lorsqu’un EventHubConsumerClient 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

Chaque lecteur d’événements se voit présenter un itérateur indépendant ; s’il y a plusieurs lecteurs, chacun reçoit sa propre copie d’un événement à traiter, plutôt que de les concurrencer.

Voir aussi

• ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Source:

EventHubConsumerClient.cs

Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible.

Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.

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)

Paramètres

partitionId

String

Identificateur de la partition Event Hub à partir de laquelle les événements seront reçus.

startingPosition

EventPosition

Position dans la partition où le consommateur doit commencer à lire les événements.

readOptions

ReadEventOptions

Ensemble d’options à utiliser pour configurer le comportement de lecture ; si ce n’est pas spécifié, les valeurs par défaut seront utilisées.

cancellationToken

CancellationToken

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

Retours

IAsyncEnumerable<PartitionEvent>

IAsyncEnumerable<T> à utiliser pour l’itération sur les événements dans la partition.

Exceptions

EventHubsException

Se produit lorsqu’un EventHubConsumerClient 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

Chaque lecteur d’événements se voit présenter un itérateur indépendant ; s’il y a plusieurs lecteurs, chacun reçoit sa propre copie d’un événement à traiter, plutôt que de les concurrencer.

Voir aussi

• ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)