SubscriptionClient.Receive Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Overloads

Receive()	Receives a message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.
Receive(Int64)	Receives a deferred message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. This method only works for deferred message, not regular one.
Receive(TimeSpan)	Receives a message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

Receive()

Receives a message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive ();

abstract member Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive () As BrokeredMessage

Returns

BrokeredMessage

The BrokeredMessage that represents the received message.

Exceptions

MessagingEntityNotFoundException

Thrown when the subscription does not exist.

TimeoutException

Thrown if the operation exceeded the timeout value set via OperationTimeout.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

UnauthorizedAccessException

Thrown if there is an authentication error.

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.

Receive(Int64)

Receives a deferred message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. This method only works for deferred message, not regular one.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (long sequenceNumber);

abstract member Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (sequenceNumber As Long) As BrokeredMessage

Parameters

sequenceNumber

Int64

The sequence number of the deferred message to receive.

Returns

BrokeredMessage

The BrokeredMessage that represents the received message.

Exceptions

OperationCanceledException

Thrown if the client entity has been closed or aborted.

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.

Receive(TimeSpan)

Receives a message using the Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (TimeSpan serverWaitTime);

abstract member Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (serverWaitTime As TimeSpan) As BrokeredMessage

Parameters

serverWaitTime

TimeSpan

The time span the server waits for receiving a message before it times out.

Returns

BrokeredMessage

The BrokeredMessage that represents the received message.

Exceptions

ArgumentOutOfRangeException

Thrown if the serverWaitTime is negative.

MessagingEntityNotFoundException

Thrown when the subscription does not exist.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

TimeoutException

Thrown if the operation exceeded the timeout value set via OperationTimeout.

UnauthorizedAccessException

Thrown if there is an authentication error.

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.