ServiceBusReceiver.PeekMessageAsync Méthode

Définition

Espace de noms:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Paquet:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

Extrait le suivant actif ServiceBusReceivedMessage sans modifier l’état du récepteur ou de la source du message.

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)

Paramètres

fromSequenceNumber

Nullable<Int64>

Numéro de séquence facultatif à partir duquel jeter un coup d’œil au message. Cela correspond à .SequenceNumber

cancellationToken

CancellationToken

Une instance facultative CancellationToken pour signaler la demande d’annulation de l’opération.

Retours

Task<ServiceBusReceivedMessage>

ServiceBusReceivedMessage qui représente le message suivant à lire. Retourne la valeur null quand rien à lire.

Remarques

Le premier appel à PeekMessageAsync(Nullable<Int64>, CancellationToken) extraire le premier message actif pour ce récepteur. Chaque appel suivant extrait le message suivant dans l’entité. Contrairement à un message reçu, un message aperçu n’aura pas de jeton de verrouillage associé, et par conséquent, il ne peut pas être Terminé/Abandonné/Différé/Deadlettered/Renewed. En outre, contrairement à ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken), cette méthode extrait même les messages différés (mais pas le message deadlettered).