StreamWebSocketControl.SupportedProtocols 属性

定义

获取一个集合,该集合可用于添加支持子协议的列表,这些子协议将在连接握手期间播发到服务器。

public:
 property IVector<Platform::String ^> ^ SupportedProtocols { IVector<Platform::String ^> ^ get(); };
IVector<winrt::hstring> SupportedProtocols();
public IList<string> SupportedProtocols { get; }
var iVector = streamWebSocketControl.supportedProtocols;
Public ReadOnly Property SupportedProtocols As IList(Of String)

属性值

IVector<String>

IList<String>

IVector<Platform::String>

IVector<winrt::hstring>

包含 StreamWebSocket 对象支持的 WebSocket 子协议的集合。

实现

注解

SupportedProtocols 属性包含 StreamWebSocket 对象支持的 WebSocket 子协议的集合。 在调用 ConnectAsync 方法之前,可以将其他受支持的子协议字符串添加到此集合中,这些字符串将在 WebSocket 握手期间以“Sec-WebSocket-Protocol”标头发送到服务器。 然后,WebSocket 服务器选择的协议将在 Protocol 属性上公开。

在成功调用 ConnectAsync 方法后,尝试将子协议添加到此集合不会导致错误,但新值将被忽略。 但是,如果 ConnectAsync 方法调用或连接操作完成并出现错误,应用可以更新存储在 SupportedProtocols 属性中的集合,然后重试 ConnectAsync 方法调用,并将应用新值。

适用于

另请参阅