你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
ServiceBusClient.AcceptSessionAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken) |
创建一个 ServiceBusSessionReceiver 实例,该实例可用于通过接受特定会话从启用会话的队列接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ,以配置消息的接收方式。 默认值是 PeekLock。 |
AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken) |
创建一个 ServiceBusSessionReceiver 实例,该实例可用于通过接受特定会话从启用会话的订阅接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ,以配置消息的接收方式。 默认值是 PeekLock。 |
AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)
- Source:
- ServiceBusClient.cs
- Source:
- ServiceBusClient.cs
创建一个 ServiceBusSessionReceiver 实例,该实例可用于通过接受特定会话从启用会话的队列接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ,以配置消息的接收方式。 默认值是 PeekLock。
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync(string queueName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AcceptSessionAsync : string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
override this.AcceptSessionAsync : string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
Public Overridable Function AcceptSessionAsync (queueName As String, sessionId As String, Optional options As ServiceBusSessionReceiverOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusSessionReceiver)
参数
- queueName
- String
要为其创建 的 ServiceBusSessionReceiver 已启用会话的队列。
- sessionId
- String
获取或设置将 范围限定为 的 ServiceBusSessionReceiver 会话 ID。
- options
- ServiceBusSessionReceiverOptions
用于配置 的ServiceBusSessionReceiver集ServiceBusSessionReceiverOptions。
- cancellationToken
- CancellationToken
一个可选 CancellationToken 实例,用于发出取消操作的请求信号。
返回
范围 ServiceBusSessionReceiver 限定为指定队列和特定会话的 。
例外
sessionId
对应于当前被另一个接收方锁定的会话。
在这种情况下, Reason 将设置为 SessionCannotBeLocked 。
注解
由于这是建立会话锁,因此此方法执行服务调用。 如果 sessionId 参数为 null,并且队列中没有可用的消息,则这会引发 ServiceBusException 具有 Reason 的 ServiceTimeout。
适用于
AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)
- Source:
- ServiceBusClient.cs
- Source:
- ServiceBusClient.cs
创建一个 ServiceBusSessionReceiver 实例,该实例可用于通过接受特定会话从启用会话的订阅接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ,以配置消息的接收方式。 默认值是 PeekLock。
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync(string topicName, string subscriptionName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AcceptSessionAsync : string * string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
override this.AcceptSessionAsync : string * string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
Public Overridable Function AcceptSessionAsync (topicName As String, subscriptionName As String, sessionId As String, Optional options As ServiceBusSessionReceiverOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusSessionReceiver)
参数
- topicName
- String
要为其创建 ServiceBusSessionReceiver 的主题。
- subscriptionName
- String
要为其创建 的 ServiceBusSessionReceiver 已启用会话的订阅。
- sessionId
- String
获取或设置将 范围限定为 的 ServiceBusSessionReceiver 会话 ID。
- options
- ServiceBusSessionReceiverOptions
用于配置 的ServiceBusSessionReceiver集ServiceBusSessionReceiverOptions。
- cancellationToken
- CancellationToken
一个可选 CancellationToken 实例,用于发出取消操作的请求信号。
返回
范围 ServiceBusSessionReceiver 限定为指定队列和特定会话的 。
例外
sessionId
对应于当前被另一个接收方锁定的会话。
在这种情况下, Reason 将设置为 SessionCannotBeLocked 。
注解
由于这是建立会话锁,因此此方法执行服务调用。 如果 sessionId 参数为 null,并且队列中没有可用的消息,则这会引发 ServiceBusException 具有 Reason 的 ServiceTimeout。