ServiceBusReceiver.PeekMessageAsync Método

Definición

Espacio de nombres:

Azure.Messaging.ServiceBus

Ensamblado:

Azure.Messaging.ServiceBus.dll

Paquete:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

Captura el siguiente activo ServiceBusReceivedMessage sin cambiar el estado del receptor o el origen del mensaje.

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>

Número de secuencia opcional desde donde se va a ver el mensaje. Esto corresponde a SequenceNumber.

cancellationToken

CancellationToken

Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.

Devoluciones

Task<ServiceBusReceivedMessage>

ServiceBusReceivedMessage que representa el siguiente mensaje que se va a leer. Devuelve null cuando no se va a ver nada.

Comentarios

La primera llamada para PeekMessageAsync(Nullable<Int64>, CancellationToken) capturar el primer mensaje activo para este receptor. Cada llamada posterior captura el mensaje subsiguiente en la entidad . A diferencia de un mensaje recibido, un mensaje inspeccionado no tendrá un token de bloqueo asociado y, por lo tanto, no puede ser Completado/ Abandonado/Diferido/Fallido/Renovado. Además, a diferencia ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)de , este método capturará incluso mensajes diferidos (pero no mensajes fallidos).