ProcessorReceiveActions.PeekMessagesAsync Method

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ProcessorReceiveActions.cs
Source:
ProcessorReceiveActions.cs

Fetches a list of active messages without changing the state of the receiver or the message source.

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

Parameters

maxMessages
Int32

The maximum number of messages that will be fetched.

fromSequenceNumber
Nullable<Int64>

An optional sequence number from where to peek the message. This corresponds to the SequenceNumber.

cancellationToken
CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task<IReadOnlyList<ServiceBusReceivedMessage>>

An IReadOnlyList<T> of messages that were peeked.

Remarks

Unlike a received message, a peeked message will not have a lock token associated with it, and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. Also, unlike ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken), this method will fetch even Deferred messages (but not Deadlettered messages).

Applies to