SubscriptionClient.ReceiveBatch Method

Definition

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);
Parameters
sequenceNumbers
IEnumerable<Int64>

The sequence number.

Returns

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);
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 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);
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

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.

Applies to