ServiceBusReceiver.ReceiveMessageAsync 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.
Receives a ServiceBusReceivedMessage from the entity using ReceiveMode mode. ReceiveMode defaults to PeekLock mode.
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessageAsync (TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>Public Overridable Function ReceiveMessageAsync (Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)Parameters
An optional TimeSpan specifying the maximum time to wait for a message before returning null if no messages are available. If not specified, the TryTimeout will be used.
- cancellationToken
- CancellationToken
An optional CancellationToken instance to signal the request to cancel the operation.
Returns
The message received. Returns null if no message is found.
