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

PartitionReceiver 类

定义

命名空间:

Azure.Messaging.EventHubs.Primitives

程序集:

Azure.Messaging.EventHubs.dll

包:

Azure.Messaging.EventHubs v5.11.3

Source:

PartitionReceiver.cs

允许从事件中心的特定分区读取事件，并在特定使用者组的上下文中读取事件，对与事件中心服务的通信的控制级别高于其他事件使用者提供的控制级别。

public class PartitionReceiver : IAsyncDisposable

type PartitionReceiver = class
    interface IAsyncDisposable

Public Class PartitionReceiver
Implements IAsyncDisposable

继承

Object

PartitionReceiver

实现

IAsyncDisposable

注解

对于大多数方案， EventProcessorClient 建议使用 或 EventHubConsumerClient 来读取和处理事件。 分区接收器旨在启用需要更直接控制的特殊需求方案。

PartitionReceiver在应用程序的生存期内可以安全地缓存和使用 ，这是应用程序定期或半定期读取事件的最佳做法。 接收方负责确保高效使用网络、CPU 和内存。 CloseAsync(CancellationToken)在应用程序关闭时调用 或 DisposeAsync() 将确保正确清理网络资源和其他非托管对象。

构造函数

PartitionReceiver()	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, EventHubConnection, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, String, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, String, String, AzureNamedKeyCredential, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, String, String, AzureSasCredential, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, String, String, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。
PartitionReceiver(String, String, EventPosition, String, String, TokenCredential, PartitionReceiverOptions)	初始化 PartitionReceiver 类的新实例。

属性

ConsumerGroup	与此客户端关联的使用者组的名称。 事件在此组的上下文中是只读的。
EventHubName	客户端连接到的事件中心的名称，特定于包含它的事件中心命名空间。
FullyQualifiedNamespace	客户端与之关联的完全限定的事件中心命名空间。 这可能类似于 {yournamespace}.servicebus.windows.net。
Identifier	用于标识此接收方的唯一名称。
InitialPosition	分区中客户端开始读取事件的位置。
IsClosed	指示是否已关闭。PartitionReceiver
PartitionId	与此客户端关联的事件中心分区的标识符。 事件将从此分区中只读。

方法

CloseAsync(CancellationToken)	关闭客户端。
DisposeAsync()	执行清理 使用 PartitionReceiver的资源所需的任务，包括确保客户端本身已关闭。
GetPartitionPropertiesAsync(CancellationToken)	检索有关此客户端关联的分区的信息，包括描述分区事件流中可用事件的元素。
ReadLastEnqueuedEventProperties()	一组有关与此接收器关联的分区的最后一个排队事件的信息，从事件中心服务接收事件时观察到。 仅当使用 set 创建 TrackLastEnqueuedEventProperties 接收方时，这才可用。 否则，属性将包含默认值。
ReceiveBatchAsync(Int32, CancellationToken)	从此客户端与之关联的事件中心分区接收一批 EventData 。
ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)	从此客户端与之关联的事件中心分区接收一批 EventData 。

另请参阅

• ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)
• ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)