你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IReceiverClient 接口
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
用于描述从 IQueueClient 和 ISubscriptionClient接收消息的常见功能的接口。
public interface IReceiverClient : Microsoft.Azure.ServiceBus.IClientEntity
type IReceiverClient = interface
interface IClientEntity
Public Interface IReceiverClient
Implements IClientEntity
- 派生
- 实现
注解
用于 IMessageReceiver 高级功能集。
属性
ClientId |
获取用于标识此客户端的 ID。 这可用于关联日志和异常。 (继承自 IClientEntity) |
IsClosedOrClosing |
如果客户端已关闭或关闭,则返回 true。 (继承自 IClientEntity) |
OperationTimeout |
持续时间过后,单个操作将超时。 (继承自 IClientEntity) |
OwnsConnection |
如果拥有连接,则返回 true;如果共享连接,则返回 false。 (继承自 IClientEntity) |
Path |
获取实体路径。 (继承自 IClientEntity) |
PrefetchCount |
在应用程序使用 Receive 请求消息时和之前,预提取旨在使消息随时可供本地检索,从而加速消息流。 设置非零值预提取预提取消息数。 将值设置为零会关闭预提取。 默认值为 0。 |
ReceiveMode |
ReceiveMode获取当前接收器的 。 |
RegisteredPlugins |
获取此客户端当前注册的插件的列表。 (继承自 IClientEntity) |
ServiceBusConnection |
服务总线命名空间的连接对象。 (继承自 IClientEntity) |
方法
AbandonAsync(String, IDictionary<String,Object>) |
Message使用锁令牌放弃 。 这会使消息再次可供处理。 |
CloseAsync() |
关闭客户端。 关闭它打开的连接。 (继承自 IClientEntity) |
CompleteAsync(String) |
Message使用锁令牌完成 。 这会从队列中删除消息。 |
DeadLetterAsync(String, IDictionary<String,Object>) |
将消息移动到死信子队列。 |
DeadLetterAsync(String, String, String) |
将消息移动到死信子队列。 |
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>) |
从实体连续接收消息。 注册消息处理程序并启动新线程以接收消息。 每当接收方收到新消息时,此处理程序 (Func<T1,T2,TResult> 等待) 。 |
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions) |
从实体连续接收消息。 注册消息处理程序并启动新线程以接收消息。 每当接收方收到新消息时,此处理程序 (Func<T1,T2,TResult> 等待) 。 |
RegisterPlugin(ServiceBusPlugin) |
ServiceBusPlugin注册要用于此客户端的 。 (继承自 IClientEntity) |
UnregisterMessageHandlerAsync(TimeSpan) |
如果注册了活动消息处理程序,则从接收方取消注册消息处理程序。 此操作等待正在进行的接收和消息处理操作完成,然后取消注册以前注册的消息处理程序上将来的接收。 |
UnregisterPlugin(String) |
取消注册 ServiceBusPlugin。 (继承自 IClientEntity) |