ServiceBusReceiver.PeekMessagesAsync Método

Definição

Namespace:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Pacote:

Azure.Messaging.ServiceBus v7.17.5

Origem:

ServiceBusReceiver.cs

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

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

Public Overridable Function PeekMessagesAsync (maxMessages As Integer, Optional fromSequenceNumber As Nullable(Of Long) = 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 buscadas.

fromSequenceNumber

Nullable<Int64>

Um número de sequência opcional de onde espiar a mensagem. Isso corresponde ao SequenceNumber.

cancellationToken

CancellationToken

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

Retornos

Task<IReadOnlyList<ServiceBusReceivedMessage>>

Uma IReadOnlyList<T> das mensagens que foram espiadas.

Comentários

Ao contrário de uma mensagem recebida, uma mensagem espiada não terá um token de bloqueio associado a ela e, portanto, não pode ser Concluída/Abandonada/Adiada/Deadlettered/Renovada. Além disso, ao contrário ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)de , esse método buscará até mesmo mensagens adiadas (mas não mensagens Deadlettered).