QueueClient.Receive 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
| Receive() |
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
| Receive(Int64) |
Receives a deferred message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. This method only works for deferred message, not regular one. |
| Receive(TimeSpan) |
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
Receive()
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.
public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive ();abstract member Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessagePublic Function Receive () As BrokeredMessageReturns
The BrokeredMessage that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.
Exceptions
Thrown if the client entity has been closed or aborted.
Thrown if the message receive operation times out.
Thrown if an I/O or security error occurs.
Thrown if the messaging entity associated with the operation does not exist or it has been deleted.
Thrown if the user code has performed some unexpected operations, or the Service Bus gateway is down. Check the exception message for the actual 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.
Applies to
Receive(Int64)
Receives a deferred message using the Microsoft.ServiceBus.Messaging.QueueClient.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.BrokeredMessagePublic Function Receive (sequenceNumber As Long) As BrokeredMessageParameters
- sequenceNumber
- Int64
The sequence number of the deferred message to receive.
Returns
The BrokeredMessage that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.
Exceptions
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.
Applies to
Receive(TimeSpan)
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.
public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (TimeSpan serverWaitTime);abstract member Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessagePublic Function Receive (serverWaitTime As TimeSpan) As BrokeredMessageParameters
- serverWaitTime
- TimeSpan
The time span the server waits for receiving a message before it times out.
Returns
The BrokeredMessage that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.
Exceptions
Thrown if the serverWaitTime is negative.
Thrown if the message receive operation times out.
Thrown if the client entity has been closed or aborted.
Thrown if an I/O or security error occurs.
Thrown if the messaging entity associated with the operation does not exist or it has been deleted.
Thrown if the user code has performed some unexpected operations, or the Service Bus gateway is down. Check the exception message for the actual 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.
