SubscriptionClient.ReceiveBatch Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Overloads

ReceiveBatch(IEnumerable<Int64>)	Receives a batch after the asynchronous operation.
ReceiveBatch(Int32)	Receives a batch after the asynchronous operation.
ReceiveBatch(Int32, TimeSpan)	Receives a batch after the asynchronous operation.

ReceiveBatch(IEnumerable<Int64>)

Receives a batch after the asynchronous operation.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (System.Collections.Generic.IEnumerable<long> sequenceNumbers);

abstract member ReceiveBatch : seq<int64> -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : seq<int64> -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>

Public Function ReceiveBatch (sequenceNumbers As IEnumerable(Of Long)) As IEnumerable(Of BrokeredMessage)

Parameters

sequenceNumbers

IEnumerable<Int64>

The sequence number.

Returns

IEnumerable<BrokeredMessage>

A batch after the asynchronous operation.

Remarks

A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but the message with the requested sequenceNumber cannot be located.

ReceiveBatch(Int32)

Receives a batch after the asynchronous operation.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (int messageCount);

abstract member ReceiveBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>

Public Function ReceiveBatch (messageCount As Integer) As 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

IEnumerable<BrokeredMessage>

A batch after the asynchronous operation.

Remarks

A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.

ReceiveBatch(Int32, TimeSpan)

Receives a batch after the asynchronous operation.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (int messageCount, TimeSpan serverWaitTime);

abstract member ReceiveBatch : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>

Public Function ReceiveBatch (messageCount As Integer, serverWaitTime As TimeSpan) As 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 the server waits for processing messages.

Returns

IEnumerable<BrokeredMessage>

A batch after the asynchronous operation.

Remarks

A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.