你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
EventHubReceiver 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。
public sealed class EventHubReceiver : Microsoft.ServiceBus.Messaging.ClientEntitytype EventHubReceiver = class
inherit ClientEntityPublic NotInheritable Class EventHubReceiver
Inherits ClientEntity- 继承
属性
| Epoch |
获取用于在接收操作期间确定分区所有权的纪元值。 |
| EventHubPath |
获取事件中心路径。 |
| Identifier |
获取在创建接收方期间设置的接收方的标识符。 |
| IsClosed |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| Name |
获取事件中心的名称。 |
| OffsetInclusive |
获取一个值，该值指示 是否 StartingOffset 被视为非独占偏移量，这意味着返回的第一个事件是包含起始偏移量的事件。 通常，返回的第一个事件是起始偏移量之后的事件。 |
| PartitionId |
获取事件中心的逻辑分区的分区 ID。 |
| PrefetchCount |
获取或设置任何接收操作将主动缓存的事件数。 默认情况下，此值继承自 EventHubConsumerGroup。 默认值为 300。 |
| PrefetchSizeInBytes |
获取或设置任何接收操作将主动缓存的最大大小 (字节) 总计。 每个事件数据的大小由 SerializedSizeInBytes 属性确定。 |
| ReceiverRuntimeMetricEnabled |
获取一个值，该值指示是否启用接收方的运行时指标。 |
| RetryPolicy |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| RuntimeInfo |
获取事件中心的逻辑分区的近似接收方运行时信息。 若要启用设置，请参阅 ReceiverOptions 和 EnableReceiverRuntimeMetric |
| StartingDateTimeUtc |
获取此接收方的 UTC 格式的开始日期和时间。 方法 Receive() 开始接收此值 StartingDateTimeUtc 后面的下一个事件。 如果为 null，接收方将从事件中心事件流的开头开始接收事件。 |
| StartingOffset |
获取此接收器的起始偏移量。 方法 Receive() 开始接收此偏移值之后的下一个事件。 如果值为 null，则接收方将从事件中心事件流的开头开始接收事件。 |
| StartingSequenceNumber |
获取此接收方的起始序列号。 方法 Receive() 开始接收此值 StartingSequenceNumber 后面的下一个事件。 |
| ThisLock |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
方法
| Abort() |
对消息传递实体执行中止功能。 (继承自 ClientEntity) |
| Close() |
将清理消息发送到服务总线，以指示实体的使用已完成。 (继承自 ClientEntity) |
| CloseAsync() |
以异步方式将清理消息发送到服务总线，以指示实体的使用已完成。 (继承自 ClientEntity) |
| Fault() |
仅限内部使用。 请勿从此类继承。 (继承自 ClientEntity) |
| OnAbort() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnBeginClose(TimeSpan, AsyncCallback, Object) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnBeginOpen(TimeSpan, AsyncCallback, Object) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnClose(TimeSpan) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnClosed() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnEndClose(IAsyncResult) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnEndOpen(IAsyncResult) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnFaulted() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnOpen(TimeSpan) |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| OnOpened() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| Receive() |
接收事件中心事件数据。 |
| Receive(Int32) |
接收事件中心事件数据，最多达到指定计数。 |
| Receive(Int32, TimeSpan) |
接收事件中心事件数据，最大为具有指定超时值的指定计数。 |
| Receive(TimeSpan) |
接收具有指定超时值的事件中心事件数据。 |
| ReceiveAsync() |
Receive() 的异步版本。 |
| ReceiveAsync(Int32) |
Receive(Int32) 的异步版本。 |
| ReceiveAsync(Int32, TimeSpan) |
Receive(Int32, TimeSpan) 的异步版本。 |
| ReceiveAsync(TimeSpan) |
Receive(TimeSpan) 的异步版本。 |
| ThrowIfClosed() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| ThrowIfDisposed() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| ThrowIfDisposedOrImmutable() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| ThrowIfDisposedOrNotOpen() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
| ThrowIfFaulted() |
在与事件中心使用者组相关的接收操作中使用的客户端类。 表示与使用者组中特定事件中心分区的逻辑接收方连接。 (继承自 ClientEntity) |
