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

SessionClient 类

定义

命名空间:

Microsoft.Azure.ServiceBus

程序集:

Microsoft.Azure.ServiceBus.dll

包:

Microsoft.Azure.ServiceBus v5.2.0

Source:

SessionClient.cs

会话客户端可用于接受会话对象，这些对象可用于与具有相同 sessionId 的所有消息进行交互。

public sealed class SessionClient : Microsoft.Azure.ServiceBus.ClientEntity, Microsoft.Azure.ServiceBus.ISessionClient

type SessionClient = class
    inherit ClientEntity
    interface ISessionClient
    interface IClientEntity

Public NotInheritable Class SessionClient
Inherits ClientEntity
Implements ISessionClient

继承

Object

ClientEntity

SessionClient

实现

IClientEntity ISessionClient

示例

创建新的 SessionClient

ISessionClient sessionClient = new SessionClient(
    namespaceConnectionString,
    queueName,
    ReceiveMode.PeekLock);

接收给定 sessionId 的会话对象

IMessageSession session = await sessionClient.AcceptMessageSessionAsync(sessionId);

接收任何会话

IMessageSession session = await sessionClient.AcceptMessageSessionAsync();

注解

可以接受使用会话客户端标识 SessionId 的任何会话或给定会话 (。 接受会话后，即可将其用作 MessageReceiver 仅接收具有相同会话 ID 的消息的 。有关会话对象的用法，请参阅 IMessageSession 。 这使用 AMQP 协议与服务通信。

构造函数

SessionClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	在给定的 上创建新的 SessionClient ServiceBusConnection
SessionClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	从 创建新的 SessionClient ServiceBusConnectionStringBuilder
SessionClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	从指定的终结点、实体路径和令牌提供程序创建新的 SessionClient。
SessionClient(String, String, ReceiveMode, RetryPolicy, Int32)	从指定的连接字符串和实体路径创建新的 SessionClient。

属性

ClientId	获取用于标识此客户端的 ID。 这可用于关联日志和异常。 (继承自 ClientEntity)
EntityPath	获取实体的路径。 这是队列的名称或订阅的完整路径。
IsClosedOrClosing	如果客户端已关闭或关闭，则返回 true。 (继承自 ClientEntity)
OperationTimeout	持续时间过后，单个操作将超时。
OwnsConnection	如果拥有连接，则返回 true;如果共享连接，则返回 false。 (继承自 ClientEntity)
Path	获取实体的路径。 这是队列的名称或订阅的完整路径。
RegisteredPlugins	获取当前注册的插件的列表。
RetryPolicy	获取 RetryPolicy 在客户端上定义的 。 (继承自 ClientEntity)
ServiceBusConnection	服务总线命名空间的连接对象。

方法

AcceptMessageSessionAsync()	获取可用于接收该 sessionId 消息的任何 SessionId 会话对象。
AcceptMessageSessionAsync(String)	获取标识 sessionId 的特定会话对象，该对象可用于接收该 sessionId 的消息。
AcceptMessageSessionAsync(String, TimeSpan)	获取标识 sessionId 的特定会话对象，该对象可用于接收该 sessionId 的消息。
AcceptMessageSessionAsync(TimeSpan)	获取可用于接收该 sessionId 消息的任何 SessionId 会话对象。
CloseAsync()	关闭客户端。 关闭它打开的连接。 (继承自 ClientEntity)
OnClosingAsync()	会话客户端可用于接受会话对象，这些对象可用于与具有相同 sessionId 的所有消息进行交互。 (继承自 ClientEntity)
RegisterPlugin(ServiceBusPlugin)	ServiceBusPlugin注册要用于此接收器的 。
ThrowIfClosed()	如果对象为“正在关闭”，则引发 OperationCanceledException。 (继承自 ClientEntity)
UnregisterPlugin(String)	取消注册 ServiceBusPlugin。

另请参阅

• IMessageSession