MessageReceiver.PeekAsync Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Core

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Overloads

PeekAsync()	Fetches the next active message without changing the state of the receiver or the message source.
PeekAsync(Int32)	Fetches the next batch of active messages without changing the state of the receiver or the message source.

PeekAsync()

Source:

MessageReceiver.cs

Fetches the next active message without changing the state of the receiver or the message source.

public System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message> PeekAsync ();

abstract member PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message>
override this.PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message>

Public Function PeekAsync () As Task(Of Message)

Returns

Task<Message>

The Message that represents the next message to be read. Returns null when nothing to peek.

Implements

PeekAsync()

Remarks

The first call to PeekAsync() fetches the first active message for this receiver. Each subsequent call fetches the subsequent message in the entity. Unlike a received message, peeked message will not have lock token associated with it, and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. Also, unlike ReceiveAsync(), this method will fetch even Deferred messages (but not Deadlettered message)

PeekAsync(Int32)

Source:

MessageReceiver.cs

Fetches the next batch of active messages without changing the state of the receiver or the message source.

public System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>> PeekAsync (int maxMessageCount);

abstract member PeekAsync : int -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>>
override this.PeekAsync : int -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>>

Public Function PeekAsync (maxMessageCount As Integer) As Task(Of IList(Of Message))

Parameters

maxMessageCount

Int32

Returns

Task<IList<Message>>

List of Message that represents the next message to be read. Returns null when nothing to peek.

Implements

PeekAsync(Int32)

Remarks

The first call to PeekAsync() fetches the first active message for this receiver. Each subsequent call fetches the subsequent message in the entity. Unlike a received message, peeked message will not have lock token associated with it, and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. Also, unlike ReceiveAsync(), this method will fetch even Deferred messages (but not Deadlettered message)