MessageReceiver.ReceiveBatch Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReceiveBatch(IEnumerable<Int64>) |
Receives a batch of messages. |
| ReceiveBatch(Int32) |
Receives a batch of messages. |
| ReceiveBatch(Int32, TimeSpan) |
Receives a batch of messages. |
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
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.
Applies to
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
The number of messages to return in the batch. As this is an approximation,
fewer or more messages than messageCount may be returned.
Returns
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.
Applies to
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
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 server wait time.
Returns
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
Azure SDK for .NET