EventHubConsumerClient.ReadEventsAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| ReadEventsAsync(CancellationToken) |
Lit les événements de toutes les partitions du hub d’événements 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 |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
Lit les événements de toutes les partitions du hub d’événements 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 |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
Lit les événements de toutes les partitions du hub d’événements 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 |
ReadEventsAsync(CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lit les événements de toutes les partitions du hub d’événements 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> ReadEventsAsync (System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)Paramètres
- cancellationToken
- CancellationToken
Une instance facultative CancellationToken pour signaler la demande d’annulation de l’opération.
Retours
IAsyncEnumerable<T> à utiliser pour l’itération sur les événements dans la partition.
Exceptions
Se produit lorsqu’un EventHubConsumerClient ne peut pas lire à partir d’Event Hub en raison d’un autre lecteur ayant affirmé la propriété exclusive. Dans ce cas, le EventHubsException.FailureReason est défini sur ConsumerDisconnected.
Remarques
Cette méthode n’est pas recommandée pour une utilisation en production ; EventProcessorClient doit être utilisé pour lire les événements de toutes les partitions dans un scénario de production, car il offre une expérience beaucoup plus robuste avec un débit plus élevé.
Il est important de noter que cette méthode ne garantit pas l’équité entre les partitions pendant l’itération ; chacune des partitions est en concurrence pour publier des événements à lire par l’énumérateur. Selon la communication du service, il peut y avoir un clustering d’événements par partition et/ou il peut y avoir un biais notable pour une partition ou un sous-ensemble de partitions donné.
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
S’applique à
ReadEventsAsync(ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lit les événements de toutes les partitions du hub d’événements 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> ReadEventsAsync (Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)Paramètres
- 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<T> à utiliser pour l’itération sur les événements dans la partition.
Exceptions
Se produit lorsqu’un EventHubConsumerClient ne peut pas lire à partir d’Event Hub en raison d’un autre lecteur ayant affirmé la propriété exclusive. Dans ce cas, le EventHubsException.FailureReason est défini sur ConsumerDisconnected.
Remarques
Cette méthode n’est pas recommandée pour une utilisation en production ; EventProcessorClient doit être utilisé pour lire les événements de toutes les partitions dans un scénario de production, car il offre une expérience beaucoup plus robuste avec un débit plus élevé.
Il est important de noter que cette méthode ne garantit pas l’équité entre les partitions pendant l’itération ; chacune des partitions est en concurrence pour publier des événements à lire par l’énumérateur. Selon la communication du service, il peut y avoir un clustering d’événements par partition et/ou il peut y avoir un biais notable pour une partition ou un sous-ensemble de partitions donné.
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
S’applique à
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lit les événements de toutes les partitions du hub d’événements 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> ReadEventsAsync (bool startReadingAtEarliestEvent, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (startReadingAtEarliestEvent As Boolean, Optional readOptions As ReadEventOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)Paramètres
- startReadingAtEarliestEvent
- Boolean
true pour commencer la lecture aux premiers événements disponibles dans chaque partition ; sinon, la lecture commence à la fin de chaque partition et voit uniquement les nouveaux événements à mesure qu’ils sont publiés.
- 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<T> à utiliser pour l’itération sur les événements dans la partition.
Exceptions
Se produit lorsqu’un EventHubConsumerClient ne peut pas lire à partir d’Event Hub en raison d’un autre lecteur ayant affirmé la propriété exclusive. Dans ce cas, le EventHubsException.FailureReason est défini sur ConsumerDisconnected.
Remarques
Cette méthode n’est pas recommandée pour une utilisation en production ; EventProcessorClient doit être utilisé pour lire les événements de toutes les partitions dans un scénario de production, car il offre une expérience beaucoup plus robuste avec un débit plus élevé.
Il est important de noter que cette méthode ne garantit pas l’équité entre les partitions pendant l’itération ; chacune des partitions est en concurrence pour publier des événements à lire par l’énumérateur. Selon la communication du service, il peut y avoir un clustering d’événements par partition et/ou il peut y avoir un biais notable pour une partition ou un sous-ensemble de partitions donné.
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
S’applique à
Azure SDK for .NET