QueueClient.ReceiveBatchAsync Method

Definition

Overloads

ReceiveBatchAsync(IEnumerable<Int64>)

Asynchronously receives a message batch.

ReceiveBatchAsync(Int32)

Asynchronously receives a message batch.

ReceiveBatchAsync(Int32, TimeSpan)

Asynchronously receives a message batch.

ReceiveBatchAsync(IEnumerable<Int64>)

Asynchronously receives a message batch.

public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (System.Collections.Generic.IEnumerable<long> sequenceNumbers);
abstract member ReceiveBatchAsync : seq<int64> -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : seq<int64> -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
Public Function ReceiveBatchAsync (sequenceNumbers As IEnumerable(Of Long)) As Task(Of IEnumerable(Of BrokeredMessage))

Parameters

sequenceNumbers
IEnumerable<Int64>

The sequence numbers associated with the messages in the batch.

Returns

The asynchronous operation.

Applies to

ReceiveBatchAsync(Int32)

Asynchronously receives a message batch.

public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (int messageCount);
abstract member ReceiveBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
Public Function ReceiveBatchAsync (messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))

Parameters

messageCount
Int32

The number of messages to return in the batch. As this is an approximation, fewer or more messages than messageCount may be returned.

Returns

The asynchronous operation.

Applies to

ReceiveBatchAsync(Int32, TimeSpan)

Asynchronously receives a message batch.

public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (int messageCount, TimeSpan serverWaitTime);
abstract member ReceiveBatchAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
Public Function ReceiveBatchAsync (messageCount As Integer, serverWaitTime As TimeSpan) As Task(Of IEnumerable(Of BrokeredMessage))

Parameters

messageCount
Int32

The number of messages to return in the batch. As this is an approximation, fewer or more messages than messageCount may be returned.

serverWaitTime
TimeSpan

The time span that the server will wait for the message batch to arrive before it times out.

Returns

The asynchronous operation.

Applies to