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

ServiceBusSessionReceiver 类

定义

命名空间:

Azure.Messaging.ServiceBus

程序集:

Azure.Messaging.ServiceBus.dll

包:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusSessionReceiver.cs

ServiceBusSessionReceiver负责从已启用会话的队列和订阅接收ServiceBusReceivedMessage和解决消息。 它是通过调用 AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)构造的。

public class ServiceBusSessionReceiver : Azure.Messaging.ServiceBus.ServiceBusReceiver

type ServiceBusSessionReceiver = class
    inherit ServiceBusReceiver

Public Class ServiceBusSessionReceiver
Inherits ServiceBusReceiver

继承

Object

ServiceBusReceiver

ServiceBusSessionReceiver

构造函数

ServiceBusSessionReceiver()

初始化 类的新实例 ServiceBusSessionReceiver 以便模拟。

属性

EntityPath	接收方连接到的服务总线实体的路径，特定于包含它的服务总线命名空间。 (继承自 ServiceBusReceiver)
FullyQualifiedNamespace	接收方与之关联的完全限定的服务总线命名空间。 这可能类似于 {yournamespace}.servicebus.windows.net。 (继承自 ServiceBusReceiver)
Identifier	用于标识接收方客户端的名称。 如果 null 或为空，则将使用随机唯一值。 (继承自 ServiceBusReceiver)
IsClosed	指示用户是否已关闭此 ServiceBusSessionReceiver 会话，或者基础会话链接是否因失去会话锁或断开链接而关闭。 如果这是 true，则接收器不能用于任何其他操作。 如果为 false，则会话锁仍可能已丢失，因此仍需处理 ServiceBusException 等于 SessionLockLost的 Reason 。
PrefetchCount	将从队列或订阅急切请求并在本地排队而不考虑处理当前是否处于活动状态的消息数，旨在通过允许接收方从本地缓存接收而不是等待服务请求来帮助最大化吞吐量 (继承自 ServiceBusReceiver)
ReceiveMode	ReceiveMode用于指定接收消息的方式的 。 (继承自 ServiceBusReceiver)
SessionId	与接收方关联的会话 ID。
SessionLockedUntil	获取 DateTimeOffset 接收方的会话被锁定到的 。

方法

AbandonMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	放弃 ServiceBusReceivedMessage。这将使消息再次可供立即处理，因为接收方持有的消息锁定将被释放。 (继承自 ServiceBusReceiver)
CloseAsync(CancellationToken)	执行清理 所使用的 ServiceBusReceiver资源所需的任务。 (继承自 ServiceBusReceiver)
CompleteMessageAsync(ServiceBusReceivedMessage, CancellationToken)	完成 ServiceBusReceivedMessage。 这会从服务中删除消息。 (继承自 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	将消息移动到死信子队列。 (继承自 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, String, String, CancellationToken)	将消息移动到死信子队列。 (继承自 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)	将消息移动到死信子队列。 (继承自 ServiceBusReceiver)
DeferMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	指示接收方希望延迟消息的处理。 (继承自 ServiceBusReceiver)
DisposeAsync()	执行清理 所使用的 ServiceBusReceiver资源所需的任务。 这等效于调用 CloseAsync(CancellationToken)。 (继承自 ServiceBusReceiver)
GetSessionStateAsync(CancellationToken)	获取会话状态。
PeekMessageAsync(Nullable<Int64>, CancellationToken)	提取下一个活动状态 ServiceBusReceivedMessage ，而不更改接收方或消息源的状态。 (继承自 ServiceBusReceiver)
PeekMessagesAsync(Int32, Nullable<Int64>, CancellationToken)	ServiceBusSessionReceiver负责从已启用会话的队列和订阅接收ServiceBusReceivedMessage和解决消息。 它是通过调用 AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)构造的。 (继承自 ServiceBusReceiver)
ReceiveDeferredMessageAsync(Int64, CancellationToken)	接收由 标识的 sequenceNumber延迟消息。 (继承自 ServiceBusReceiver)
ReceiveDeferredMessagesAsync(IEnumerable<Int64>, CancellationToken)	接收由 sequenceNumbers标识的延迟消息的列表。 (继承自 ServiceBusReceiver)
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	ServiceBusReceivedMessage使用 ReceiveMode 模式从实体接收 。 ReceiveMode 默认为 PeekLock 模式。 (继承自 ServiceBusReceiver)
ReceiveMessagesAsync(CancellationToken)	使用 ReceiveMode 模式从实体接收异步可枚举的消息。 ReceiveMode 默认为 PeekLock 模式。 当循环访问 IAsyncEnumerable 时，将从实体接收消息。 如果没有可用的消息，此方法将继续轮询，直到消息可用，即永远不会返回 null。 (继承自 ServiceBusReceiver)
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	使用 ReceiveMode 模式从实体接收 的列表ServiceBusReceivedMessage。 ReceiveMode 默认为 PeekLock 模式。 即使队列或主题中有可用的消息，maxMessages此方法也不保证返回确切maxMessages的消息。 (继承自 ServiceBusReceiver)
RenewMessageLockAsync(ServiceBusReceivedMessage, CancellationToken)	续订消息上的锁。 将根据队列中指定的设置续订锁。 (继承自 ServiceBusReceiver)
RenewSessionLockAsync(CancellationToken)	在 指定的 SessionId会话上续订锁。 将根据实体上指定的设置续订锁。
SetSessionStateAsync(BinaryData, CancellationToken)	在会话上设置自定义状态，以后可以使用 GetSessionStateAsync(CancellationToken)