ServiceBusReceiver.PeekMessageAsync Método

Definição

Namespace:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Pacote:

Azure.Messaging.ServiceBus v7.17.5

Origem:

ServiceBusReceiver.cs

Busca o próximo ativo ServiceBusReceivedMessage sem alterar o estado do receptor ou a origem da mensagem.

public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> PeekMessageAsync (long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>

Public Overridable Function PeekMessageAsync (Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)

Parâmetros

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<ServiceBusReceivedMessage>

O ServiceBusReceivedMessage que representa a próxima mensagem a ser lida. Retorna nulo quando nada para espiar.

Comentários

A primeira chamada para PeekMessageAsync(Nullable<Int64>, CancellationToken) buscar a primeira mensagem ativa para esse receptor. Cada chamada subsequente busca a mensagem subsequente na entidade. 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 mensagem Deadlettered).