MessageReceiver.ReceiveBatch MessageReceiver.ReceiveBatch MessageReceiver.ReceiveBatch Method

Definition

Namespace:
Microsoft.ServiceBus.Messaging Microsoft.ServiceBus.Messaging Microsoft.ServiceBus.Messaging
Assembly:
Microsoft.ServiceBus.dll

Overloads

ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>)

Receives a batch of messages.
ReceiveBatch(Int32) ReceiveBatch(Int32) ReceiveBatch(Int32)

Receives a batch of messages.
ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan)

Receives a batch of messages.

ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>)

Receives a batch of messages.

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 numbers.

Returns
IEnumerable<BrokeredMessage>

A batch of messages.

Remarks

A Null can be returned 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) ReceiveBatch(Int32) ReceiveBatch(Int32)

Receives a batch of messages.

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 Int32 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 of messages.

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) ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan)

Receives a batch of messages.

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 Int32 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 TimeSpan TimeSpan

The server wait time.

Returns
IEnumerable<BrokeredMessage>

A batch of messages.

Remarks

A Null can be returned by this API if operation exceeded the timeout specified,

        or the operations succeeded but there are no more messages to be received.

Applies to