EventHubConsumerClient.ReadEventsAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| ReadEventsAsync(CancellationToken) |
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um |
ReadEventsAsync(CancellationToken)
- Origem:
- EventHubConsumerClient.cs
- Origem:
- EventHubConsumerClient.cs
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis.
Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
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
Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.
Retornos
Um IAsyncEnumerable<T> a ser usado para iterar em eventos na partição.
Exceções
Ocorre quando um EventHubConsumerClient não consegue ler do Hub de Eventos devido a outro leitor ter declarado propriedade exclusiva. Nesse caso, o EventHubsException.FailureReason será definido ConsumerDisconnectedcomo .
Comentários
Esse método não é recomendado para uso em produção; o EventProcessorClient deve ser usado para ler eventos de todas as partições em um cenário de produção, pois oferece uma experiência muito mais robusta com maior taxa de transferência.
É importante observar que esse método não garante a imparcialidade entre as partições durante a iteração; cada uma das partições compete para publicar eventos a serem lidos pelo enumerador. Dependendo da comunicação do serviço, pode haver uma clustering de eventos por partição e/ou pode haver um viés perceptível para uma determinada partição ou subconjunto de partições.
Cada leitor de eventos é apresentado com um iterador independente; se houver vários leitores, cada um receberá sua própria cópia de um evento a ser processado, em vez de competir por eles.
Confira também
Aplica-se a
ReadEventsAsync(ReadEventOptions, CancellationToken)
- Origem:
- EventHubConsumerClient.cs
- Origem:
- EventHubConsumerClient.cs
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis.
Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
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
O conjunto de opções a serem usadas para configurar o comportamento de leitura; se não for especificado, os padrões serão usados.
- cancellationToken
- CancellationToken
Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.
Retornos
Um IAsyncEnumerable<T> a ser usado para iterar em eventos na partição.
Exceções
Ocorre quando um EventHubConsumerClient não consegue ler do Hub de Eventos devido a outro leitor ter declarado propriedade exclusiva. Nesse caso, o EventHubsException.FailureReason será definido ConsumerDisconnectedcomo .
Comentários
Esse método não é recomendado para uso em produção; o EventProcessorClient deve ser usado para ler eventos de todas as partições em um cenário de produção, pois oferece uma experiência muito mais robusta com maior taxa de transferência.
É importante observar que esse método não garante a imparcialidade entre as partições durante a iteração; cada uma das partições compete para publicar eventos a serem lidos pelo enumerador. Dependendo da comunicação do serviço, pode haver uma clustering de eventos por partição e/ou pode haver um viés perceptível para uma determinada partição ou subconjunto de partições.
Cada leitor de eventos é apresentado com um iterador independente; se houver vários leitores, cada um receberá sua própria cópia de um evento a ser processado, em vez de competir por eles.
Confira também
Aplica-se a
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)
- Origem:
- EventHubConsumerClient.cs
- Origem:
- EventHubConsumerClient.cs
Lê eventos de todas as partições do hub de eventos como um enumerável assíncrono, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis.
Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
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 começar a ler os primeiros eventos disponíveis em cada partição; caso contrário, a leitura começará no final de cada partição, vendo apenas novos eventos conforme eles são publicados.
- readOptions
- ReadEventOptions
O conjunto de opções a serem usadas para configurar o comportamento de leitura; se não for especificado, os padrões serão usados.
- cancellationToken
- CancellationToken
Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.
Retornos
Um IAsyncEnumerable<T> a ser usado para iterar em eventos na partição.
Exceções
Ocorre quando um EventHubConsumerClient não consegue ler do Hub de Eventos devido a outro leitor ter declarado propriedade exclusiva. Nesse caso, o EventHubsException.FailureReason será definido ConsumerDisconnectedcomo .
Comentários
Esse método não é recomendado para uso em produção; o EventProcessorClient deve ser usado para ler eventos de todas as partições em um cenário de produção, pois oferece uma experiência muito mais robusta com maior taxa de transferência.
É importante observar que esse método não garante a imparcialidade entre as partições durante a iteração; cada uma das partições compete para publicar eventos a serem lidos pelo enumerador. Dependendo da comunicação do serviço, pode haver uma clustering de eventos por partição e/ou pode haver um viés perceptível para uma determinada partição ou subconjunto de partições.
Cada leitor de eventos é apresentado com um iterador independente; se houver vários leitores, cada um receberá sua própria cópia de um evento a ser processado, em vez de competir por eles.
Confira também
Aplica-se a
Azure SDK for .NET