ServiceBusReceiveActions.ReceiveMessagesAsync Método

Definição

Namespace:

Microsoft.Azure.WebJobs.ServiceBus

Assembly:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Pacote:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.1

Origem:

ServiceBusReceiveActions.cs

Recebe uma lista de ServiceBusReceivedMessage da entidade. Esse método não garante o retorno de mensagens exatas maxMessages , mesmo que haja maxMessages mensagens disponíveis na fila ou no tópico. As mensagens recebidas usando esse método estão sujeitas ao comportamento definido no AutoCompleteMessages. Quando esse método é usado em funções de expedição única, as mensagens recebidas estão sujeitas a MaxAutoLockRenewalDuration.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync (int maxMessages, TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>

Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

Parâmetros

maxMessages

Int32

O número máximo de mensagens que serão recebidas.

maxWaitTime

Nullable<TimeSpan>

Um opcional TimeSpan que especifica o tempo máximo para aguardar a primeira mensagem antes de retornar uma lista vazia se nenhuma mensagem estiver disponível. Se não for especificado, o TryTimeout será usado.

cancellationToken

CancellationToken

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

Retornos

Task<IReadOnlyList<ServiceBusReceivedMessage>>

Lista de mensagens recebidas. Retornará uma lista vazia se nenhuma mensagem for encontrada.