你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
HybridConnectionListener 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供用于接受来自远程客户端的 HybridConnection 的侦听器。
public class HybridConnectionListener : Microsoft.Azure.Relay.IConnectionStatus
type HybridConnectionListener = class
interface IConnectionStatus
Public Class HybridConnectionListener
Implements IConnectionStatus
- 继承
-
HybridConnectionListener
- 实现
构造函数
HybridConnectionListener(String) |
使用指定的连接字符串创建 的新 HybridConnectionListener 实例。 仅当 AAD 不是身份验证方法时,才使用此重载。 |
HybridConnectionListener(String, String) |
从连接字符串和指定的 HybridConection 路径创建 的新实例 HybridConnectionListener 。 仅当连接字符串不使用 EntityPath 属性且 AAD 不是身份验证方法时,才使用此重载。 |
HybridConnectionListener(Uri, TokenProvider) |
创建新的 HybridConnectionListener 实例以接受 HybridConnections。 |
属性
AcceptHandler |
允许安装自定义处理程序,该处理程序可以检查请求标头、控制响应标头、决定是接受还是拒绝 Web 套接字升级请求,以及控制状态代码/说明(如果拒绝)。 AcceptHandler 应返回 true 以接受客户端请求,或返回 false 以拒绝。 |
Address |
获取要侦听 HybridConnections 的地址。 此地址的格式应为“sb://contoso.servicebus.windows.net/yourhybridconnection”。 |
ClientWebSocketFactory |
自定义 ClientWebSocket 实现。 |
IsOnline |
获取一个值,该值确定连接是否联机。 |
KeepAliveInterval |
Websocket 的保持连接间隔。 |
LastError |
检索尝试从脱机状态重新建立连接时遇到的最后一个错误。 |
Proxy |
获取或设置用于连接到 ServiceBus 的代理信息。 |
RequestHandler |
安装混合 Http 请求的处理程序。 |
TokenProvider |
获取用于对此 HybridConnection 侦听器进行身份验证的 TokenProvider。 |
TrackingContext |
获取此侦听器的 TrackingContext。 |
UseBuiltInClientWebSocket |
控制是使用来自 .NET Core 的 ClientWebSocket 还是使用自定义实现。 如果配置了自定义 ClientWebSocketFactory ,则忽略此属性。 |
方法
AcceptConnectionAsync() |
接受由远程客户端启动并返回 Stream 的新 HybridConnection。 |
CloseAsync() |
HybridConnectionListener使用默认超时关闭 。 除非在连接字符串中指定,否则默认值为 1 分钟。 |
CloseAsync(CancellationToken) |
HybridConnectionListener使用提供的 CancellationToken 关闭 。 |
CloseAsync(TimeSpan) |
HybridConnectionListener使用提供的超时关闭 。 |
GetRuntimeInformationAsync() |
HybridConnectionRuntimeInformation使用默认超时获取此 HybridConnection 实体的 。 除非在连接字符串中指定,否则默认值为 1 分钟。 |
GetRuntimeInformationAsync(CancellationToken) |
使用提供的 CancellationToken HybridConnectionRuntimeInformation 获取此 HybridConnection 实体的 。 |
OpenAsync() |
打开 并在 HybridConnectionListener ServiceBus 中将其注册为侦听器。 除非在连接字符串中指定,否则默认值为 1 分钟。 |
OpenAsync(CancellationToken) |
打开 并在 HybridConnectionListener ServiceBus 中将其注册为侦听器。 |
OpenAsync(TimeSpan) |
打开 并在 HybridConnectionListener ServiceBus 中将其注册为侦听器。 |
ToString() |
返回表示当前对象的字符串。 包含用于端到端关联的 TrackingId。 |
事件
Connecting |
当侦听器尝试在连接丢失后重新连接到 ServiceBus 时引发。 有关更多详细信息,请查看 LastError。 |
Offline |
当侦听器不再尝试重新连接到 ServiceBus 时引发。 原因包括用户启动的侦听器关闭或已删除 HybridConnection 管理对象 (例如通过门户或 ARM) 。 检查 LastError 以了解此事件意外引发时的更多详细信息。 |
Online |
当侦听器已成功连接或重新连接到 ServiceBus 时引发。 此时 LastError 将为 null。 |