MessageReceiver.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(TimeSpan) |
Receives a BrokeredMessage from the current queue or topic. |
| Receive() |
Receives a BrokeredMessage from the current queue or topic. |
| Receive(Int64) |
Receives a deferred message from the current queue or topic. This method only works for deferred message, not regular one. |
Receive(TimeSpan)
Receives a BrokeredMessage from the current queue or topic.
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 before the operation times out.
Returns
The BrokeredMessage that represents the received message.
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
Receive()
Receives a BrokeredMessage from the current queue or topic.
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.
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
Receive(Int64)
Receives a deferred message from the current queue or topic. 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.
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.
