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

EventHubConsumerClient.ReadEventsFromPartitionAsync 方法

定义

重载

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

从请求的分区中读取事件作为异步枚举对象,允许事件在分区上可用时进行迭代,在没有可用事件时根据需要等待。

如果事件在分区上不可用,此枚举器可能会阻止 不确定的时间 await 量,要求通过 cancellationToken 请求取消以返回控制权。 建议调用重载,该重载接受一组选项,用于在需要更确定的最长等待期的情况下配置读取行为。

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

从请求的分区中读取事件作为异步枚举对象,允许事件在分区上可用时进行迭代,在没有可用事件时根据需要等待。

如果事件在分区上不可用,此枚举器可能会阻止 不确定的时间 await 量,要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Source:
EventHubConsumerClient.cs
Source:
EventHubConsumerClient.cs

从请求的分区中读取事件作为异步枚举对象,允许事件在分区上可用时进行迭代,在没有可用事件时根据需要等待。

如果事件在分区上不可用,此枚举器可能会阻止 不确定的时间 await 量,要求通过 cancellationToken 请求取消以返回控制权。 建议调用重载,该重载接受一组选项,用于在需要更确定的最长等待期的情况下配置读取行为。

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

参数

partitionId
String

将从中接收事件的事件中心分区的标识符。

startingPosition
EventPosition

分区中使用者应开始读取事件的位置。

cancellationToken
CancellationToken

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

返回

IAsyncEnumerable<T>用于循环访问分区中的事件。

例外

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

注解

事件的每个读取者都呈现一个独立的迭代器;如果有多个读取器,则每个人都会收到自己要处理的事件副本,而不是争用它们。

另请参阅

适用于

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Source:
EventHubConsumerClient.cs
Source:
EventHubConsumerClient.cs

从请求的分区中读取事件作为异步枚举对象,允许事件在分区上可用时进行迭代,在没有可用事件时根据需要等待。

如果事件在分区上不可用,此枚举器可能会阻止 不确定的时间 await 量,要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

参数

partitionId
String

将从中接收事件的事件中心分区的标识符。

startingPosition
EventPosition

分区中使用者应开始读取事件的位置。

readOptions
ReadEventOptions

用于配置读取行为的选项集;如果未指定,将使用默认值。

cancellationToken
CancellationToken

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

返回

IAsyncEnumerable<T>用于循环访问分区中的事件。

例外

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

注解

事件的每个读取者都呈现一个独立的迭代器;如果有多个读取器,则每个人都会收到自己要处理的事件副本,而不是争用它们。

另请参阅

适用于