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

PartitionReceiver.ReceiveBatchAsync 方法

定义

命名空间:

Azure.Messaging.EventHubs.Primitives

程序集:

Azure.Messaging.EventHubs.dll

包:

Azure.Messaging.EventHubs v5.11.3

重载

ReceiveBatchAsync(Int32, CancellationToken)	从此客户端与之关联的事件中心分区接收一批 EventData 。
ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)	从此客户端与之关联的事件中心分区接收一批 EventData 。

ReceiveBatchAsync(Int32, CancellationToken)

Source:

PartitionReceiver.cs

从此客户端与之关联的事件中心分区接收一批 EventData 。

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>

Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

参数

maximumEventCount

Int32

要在此批处理中接收的最大消息数。

cancellationToken

CancellationToken

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

返回

Task<IEnumerable<EventData>>

与此客户端关联的事件中心分区的 批处理 EventData 。 如果不存在任何事件，则返回空枚举对象。

例外

ArgumentOutOfRangeException

当请求 maximumEventCount 的小于 1 时发生。

EventHubsException

当 由于另一个 PartitionReceiver 读取器断言独占所有权而无法从请求的事件中心分区读取时发生。 在这种情况下， EventHubsException.FailureReason 将设置为 ConsumerDisconnected。

注解

当事件在预提取队列中可用时，它们将用于尽快形成批处理，而无需等待事件中心服务中的其他事件来尝试满足请求的 maximumEventCount。 如果预提取中没有可用的事件，接收方将等待活动重试策略中指定的持续时间 TryTimeout ，以便从服务中读取事件。 任何事件可用后，它们将用于立即形成批处理。

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

Source:

PartitionReceiver.cs

从此客户端与之关联的事件中心分区接收一批 EventData 。

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, TimeSpan maximumWaitTime, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>

Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, maximumWaitTime As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))

参数

maximumEventCount

Int32

要在此批处理中接收的最大消息数。

maximumWaitTime

TimeSpan

如果无法从预提取队列读取事件，则等待事件变为可用的最长时间。

cancellationToken

CancellationToken

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

返回

Task<IEnumerable<EventData>>

与此客户端关联的事件中心分区的 批处理 EventData 。 如果不存在任何事件，则返回空枚举对象。

例外

ArgumentOutOfRangeException

当请求 maximumEventCount 的小于 1 时发生。

EventHubsException

当 由于另一个 PartitionReceiver 读取器断言独占所有权而无法从请求的事件中心分区读取时发生。 在这种情况下， EventHubsException.FailureReason 将设置为 ConsumerDisconnected。

注解

当事件在预提取队列中可用时，它们将用于尽快形成批处理，而无需等待事件中心服务中的其他事件来尝试满足请求的 maximumEventCount。 如果预提取中没有可用的事件，接收方将等待从 maximumWaitTime 服务中读取事件。 任何事件可用后，它们将用于立即形成批处理。