EventHubConsumerClient.ReadEventsFromPartitionAsync Método

Definição

Namespace:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Pacote:

Azure.Messaging.EventHubs v5.11.3

Sobrecargas

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Lê eventos da partição solicitada como uma enumerável assíncrona, 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 o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável chamar a sobrecarga que aceita um conjunto de opções para configurar o comportamento de leitura para cenários em que um período de espera máximo mais determinístico é desejado.

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Lê eventos da partição solicitada como uma enumerável assíncrona, 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 o 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.

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Origem:

EventHubConsumerClient.cs

Lê eventos da partição solicitada como uma enumerável assíncrona, 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 o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável chamar a sobrecarga que aceita um conjunto de opções para configurar o comportamento de leitura 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> 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)

Parâmetros

partitionId

String

O identificador da partição do Hub de Eventos da qual os eventos serão recebidos.

startingPosition

EventPosition

A posição dentro da partição em que o consumidor deve começar a ler eventos.

cancellationToken

CancellationToken

Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.

Retornos

IAsyncEnumerable<PartitionEvent>

Um IAsyncEnumerable<T> a ser usado para iterar em eventos na partição.

Exceções

EventHubsException

Ocorre quando um EventHubConsumerClient não consegue ler a partir da partição do Hub de Eventos solicitada devido a outro leitor ter declarado propriedade exclusiva. Nesse caso, o EventHubsException.FailureReason será definido ConsumerDisconnectedcomo .

Comentários

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

• ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Origem:

EventHubConsumerClient.cs

Lê eventos da partição solicitada como uma enumerável assíncrona, 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 o 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> 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)

Parâmetros

partitionId

String

O identificador da partição do Hub de Eventos da qual os eventos serão recebidos.

startingPosition

EventPosition

A posição dentro da partição em que o consumidor deve começar a ler eventos.

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

IAsyncEnumerable<PartitionEvent>

Um IAsyncEnumerable<T> a ser usado para iterar em eventos na partição.

Exceções

EventHubsException

Ocorre quando um EventHubConsumerClient não consegue ler a partir da partição do Hub de Eventos solicitada devido a outro leitor ter declarado propriedade exclusiva. Nesse caso, o EventHubsException.FailureReason será definido ConsumerDisconnectedcomo .

Comentários

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

• ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)