QueueClient.ReceiveBatch Method

Definition

Overloads

ReceiveBatch(IEnumerable<Int64>)

Receives a message batch.

ReceiveBatch(Int32)

Receives a message batch.

ReceiveBatch(Int32, TimeSpan)

Receives a message batch.

ReceiveBatch(IEnumerable<Int64>)

Receives a message batch.

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

The sequence numbers associated with the messages in the batch.

Returns

A message batch.

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 message batch.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (int messageCount);
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 message batch.

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 message batch.

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

The number of messages to receive in a 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

A message batch.

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.