PartitionReceiver.ReceiveBatchAsync Método

Definição

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Pacote:

Azure.Messaging.EventHubs v5.11.3

Sobrecargas

ReceiveBatchAsync(Int32, CancellationToken)	Recebe um lote de EventData da partição do Hub de Eventos à qual esse cliente está associado.
ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)	Recebe um lote de EventData da partição do Hub de Eventos à qual esse cliente está associado.

ReceiveBatchAsync(Int32, CancellationToken)

Origem:

PartitionReceiver.cs

Recebe um lote de EventData da partição do Hub de Eventos à qual esse cliente está associado.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>

Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

Parâmetros

maximumEventCount

Int32

O número máximo de mensagens a serem recebidas neste lote.

cancellationToken

CancellationToken

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

Retornos

Task<IEnumerable<EventData>>

O lote de EventData da partição do Hub de Eventos ao qual esse cliente está associado. Se nenhum evento estiver presente, um enumerável vazio será retornado.

Exceções

ArgumentOutOfRangeException

Ocorre quando o solicitado maximumEventCount é menor que 1.

EventHubsException

Ocorre quando um PartitionReceiver não consegue ler a 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

Quando os eventos estiverem disponíveis na fila de pré-busca, eles serão usados para formar o lote o mais rápido possível sem aguardar eventos adicionais do serviço hubs de eventos para tentar atender ao solicitado maximumEventCount. Quando nenhum evento estiver disponível na pré-busca, o receptor aguardará até a duração especificada pelo TryTimeout na política de repetição ativa para que os eventos sejam lidos do serviço. Depois que todos os eventos estiverem disponíveis, eles serão usados para formar o lote imediatamente.

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

Origem:

PartitionReceiver.cs

Recebe um lote de EventData da partição do Hub de Eventos à qual esse cliente está associado.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, TimeSpan maximumWaitTime, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>

Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, maximumWaitTime As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

Parâmetros

maximumEventCount

Int32

O número máximo de mensagens a serem recebidas neste lote.

maximumWaitTime

TimeSpan

O tempo máximo de espera para que os eventos fiquem disponíveis, se nenhum evento puder ser lido na fila de pré-busca.

cancellationToken

CancellationToken

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

Retornos

Task<IEnumerable<EventData>>

O lote de EventData da partição do Hub de Eventos ao qual esse cliente está associado. Se nenhum evento estiver presente, um enumerável vazio será retornado.

Exceções

ArgumentOutOfRangeException

Ocorre quando o solicitado maximumEventCount é menor que 1.

EventHubsException

Ocorre quando um PartitionReceiver não consegue ler a 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

Quando os eventos estiverem disponíveis na fila de pré-busca, eles serão usados para formar o lote o mais rápido possível sem aguardar eventos adicionais do serviço hubs de eventos para tentar atender ao solicitado maximumEventCount. Quando nenhum evento estiver disponível na pré-busca, o receptor aguardará até o para que os maximumWaitTime eventos sejam lidos do serviço. Depois que todos os eventos estiverem disponíveis, eles serão usados para formar o lote imediatamente.