StreamWebSocketControl.SupportedProtocols Eigenschaft

Definition

Namespace:

Windows.Networking.Sockets

Ruft eine Auflistung ab, die verwendet werden kann, um eine Liste der unterstützten Unterprotokolle hinzuzufügen, die während des Verbindungshandhakes auf dem Server angekündigt werden.

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)

Eigenschaftswert

IVector<String>

IList<String>

IVector<Platform::String>

IVector<winrt::hstring>

Eine Auflistung, die die vom StreamWebSocket-Objekt unterstützten WebSocket-Unterprotokolle enthält.

Implementiert

SupportedProtocols

Hinweise

Die SupportedProtocols-Eigenschaft enthält eine Auflistung von WebSocket-Unterprotokollen, die vom StreamWebSocket-Objekt unterstützt werden. Vor dem Aufrufen der ConnectAsync-Methode können dieser Auflistung zusätzliche unterstützte Unterprotokollzeichenfolgen hinzugefügt werden, die während des WebSocket-Handshakes im Header "Sec-WebSocket-Protocol" an den Server gesendet werden. Das vom WebSocket-Server ausgewählte Protokoll wird dann für die Protocol-Eigenschaft verfügbar gemacht.

Ein Versuch, dieser Auflistung nach einem erfolgreichen Aufruf der ConnectAsync-Methode ein Unterprotokoll hinzuzufügen, führt nicht zu einem Fehler, aber der neue Wert wird ignoriert. Wenn jedoch der Aufruf der ConnectAsync-Methode oder der Verbindungsvorgang mit einem Fehler abgeschlossen wird, kann eine App die in der SupportedProtocols-Eigenschaft gespeicherte Auflistung aktualisieren und den Aufruf der ConnectAsync-Methode wiederholen, und der neue Wert wird angewendet.

Weitere Informationen

• StreamWebSocket
• Protocol
• Verwenden erweiterter WebSocket-Steuerelemente