你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ServiceBusReceiver.ReceiveMessagesAsync 方法

定义

命名空间:

Azure.Messaging.ServiceBus

程序集:

Azure.Messaging.ServiceBus.dll

包:

Azure.Messaging.ServiceBus v7.18.4

重载

ReceiveMessagesAsync(CancellationToken)	使用 ReceiveMode 模式从实体接收异步可枚举的消息。 ReceiveMode 默认为 PeekLock 模式。 当循环访问 IAsyncEnumerable 时，将从实体接收消息。 如果没有可用的消息，此方法将继续轮询，直到消息可用，即永远不会返回 null。
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	使用 ReceiveMode 模式从实体接收 的列表ServiceBusReceivedMessage。 ReceiveMode 默认为 PeekLock 模式。 即使队列或主题中有可用的消息，maxMessages此方法也不保证返回确切maxMessages的消息。

ReceiveMessagesAsync(CancellationToken)

Source:

ServiceBusReceiver.cs

使用 ReceiveMode 模式从实体接收异步可枚举的消息。 ReceiveMode 默认为 PeekLock 模式。 当循环访问 IAsyncEnumerable 时，将从实体接收消息。 如果没有可用的消息，此方法将继续轮询，直到消息可用，即永远不会返回 null。

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessagesAsync(System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>

Public Overridable Function ReceiveMessagesAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of ServiceBusReceivedMessage)

参数

cancellationToken

CancellationToken

一个可选 CancellationToken 实例，用于发出取消操作的请求信号。

返回

IAsyncEnumerable<ServiceBusReceivedMessage>

收到的消息。

ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)

Source:

ServiceBusReceiver.cs

使用 ReceiveMode 模式从实体接收 的列表ServiceBusReceivedMessage。 ReceiveMode 默认为 PeekLock 模式。 即使队列或主题中有可用的消息，maxMessages此方法也不保证返回确切maxMessages的消息。

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync(int maxMessages, TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>

Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

参数

maxMessages

Int32

将接收的最大消息数。

maxWaitTime

Nullable<TimeSpan>

可选 TimeSpan ，指定在没有任何可用消息时返回空列表之前等待第一条消息的最长时间。 如果未指定， TryTimeout 将使用 。

cancellationToken

CancellationToken

一个可选 CancellationToken 实例，用于发出取消操作的请求信号。

返回

Task<IReadOnlyList<ServiceBusReceivedMessage>>

收到的消息列表。 如果未找到消息，则返回空列表。