EventHubConsumerClient.ReadEventsAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| ReadEventsAsync(CancellationToken) |
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un |
ReadEventsAsync(CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles.
Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
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)Parámetros
- cancellationToken
- CancellationToken
Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.
Devoluciones
que IAsyncEnumerable<T> se va a usar para recorrer en iteración los eventos de la partición.
Excepciones
Se produce cuando no EventHubConsumerClient se puede leer desde el centro de eventos debido a que otro lector ha declarado la propiedad exclusiva. En este caso, se establecerá ConsumerDisconnecteden EventHubsException.FailureReason .
Comentarios
Este método no se recomienda para su uso en producción; EventProcessorClient se debe usar para leer eventos de todas las particiones de un escenario de producción, ya que ofrece una experiencia mucho más sólida con un mayor rendimiento.
Es importante tener en cuenta que este método no garantiza la equidad entre las particiones durante la iteración; cada una de las particiones compite por publicar eventos que el enumerador leerá. En función de la comunicación del servicio, puede haber una agrupación en clústeres de eventos por partición o puede haber un sesgo notable para una partición determinada o un subconjunto de particiones.
Cada lector de eventos se presenta con un iterador independiente; si hay varios lectores, cada uno recibe su propia copia de un evento que se va a procesar, en lugar de competir por ellos.
Consulte también
Se aplica a
ReadEventsAsync(ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles.
Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
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)Parámetros
- readOptions
- ReadEventOptions
Conjunto de opciones que se van a usar para configurar el comportamiento de lectura; si no se especifican los valores predeterminados se usarán.
- cancellationToken
- CancellationToken
Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.
Devoluciones
que IAsyncEnumerable<T> se va a usar para recorrer en iteración los eventos de la partición.
Excepciones
Se produce cuando no EventHubConsumerClient se puede leer desde el centro de eventos debido a que otro lector ha declarado la propiedad exclusiva. En este caso, se establecerá ConsumerDisconnecteden EventHubsException.FailureReason .
Comentarios
Este método no se recomienda para su uso en producción; EventProcessorClient se debe usar para leer eventos de todas las particiones de un escenario de producción, ya que ofrece una experiencia mucho más sólida con un mayor rendimiento.
Es importante tener en cuenta que este método no garantiza la equidad entre las particiones durante la iteración; cada una de las particiones compite por publicar eventos que el enumerador leerá. En función de la comunicación del servicio, puede haber una agrupación en clústeres de eventos por partición o puede haber un sesgo notable para una partición determinada o un subconjunto de particiones.
Cada lector de eventos se presenta con un iterador independiente; si hay varios lectores, cada uno recibe su propia copia de un evento que se va a procesar, en lugar de competir por ellos.
Consulte también
Se aplica a
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles.
Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
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)Parámetros
- startReadingAtEarliestEvent
- Boolean
true para empezar a leer en los primeros eventos disponibles en cada partición; De lo contrario, la lectura comenzará al final de cada partición y solo verá nuevos eventos a medida que se publican.
- readOptions
- ReadEventOptions
Conjunto de opciones que se van a usar para configurar el comportamiento de lectura; si no se especifican los valores predeterminados se usarán.
- cancellationToken
- CancellationToken
Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.
Devoluciones
que IAsyncEnumerable<T> se va a usar para recorrer en iteración los eventos de la partición.
Excepciones
Se produce cuando no EventHubConsumerClient se puede leer desde el centro de eventos debido a que otro lector ha declarado la propiedad exclusiva. En este caso, se establecerá ConsumerDisconnecteden EventHubsException.FailureReason .
Comentarios
Este método no se recomienda para su uso en producción; EventProcessorClient se debe usar para leer eventos de todas las particiones de un escenario de producción, ya que ofrece una experiencia mucho más sólida con un mayor rendimiento.
Es importante tener en cuenta que este método no garantiza la equidad entre las particiones durante la iteración; cada una de las particiones compite por publicar eventos que el enumerador leerá. En función de la comunicación del servicio, puede haber una agrupación en clústeres de eventos por partición o puede haber un sesgo notable para una partición determinada o un subconjunto de particiones.
Cada lector de eventos se presenta con un iterador independiente; si hay varios lectores, cada uno recibe su propia copia de un evento que se va a procesar, en lugar de competir por ellos.
Consulte también
Se aplica a
Azure SDK for .NET