StreamWebSocketControl Klasse

Definition

Namespace:

Windows.Networking.Sockets

Stellt Socketsteuerelementdaten für ein StreamWebSocket -Objekt bereit.

public ref class StreamWebSocketControl sealed : IWebSocketControl2

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class StreamWebSocketControl final : IWebSocketControl2

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class StreamWebSocketControl : IWebSocketControl2

Public NotInheritable Class StreamWebSocketControl
Implements IWebSocketControl2

Vererbung

Object Platform::Object IInspectable StreamWebSocketControl

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute

Implementiert

IWebSocketControl IWebSocketControl2

Windows-Anforderungen

Anforderungen	Beschreibung
Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)
App-Funktionen	internetClient privateNetworkClientServer

Hinweise

Die StreamWebSocketControl-Klasse bietet Zugriff auf erweiterte Socketsteuerungsdaten in einem StreamWebSocket-Objekt .

Ein StreamWebSocketControl-Objekt wird automatisch mit dem übergeordneten StreamWebSocket-Objekt erstellt. Die StreamWebSocket.Control-Eigenschaft bietet Zugriff auf das zugeordnete StreamWebSocketControl-Objekt.

Alle Änderungen an den StreamWebSocketControl-Eigenschaftswerten müssen festgelegt werden, bevor das StreamWebSocket verbunden ist. Wenn Sie daher Änderungen an den Eigenschaften NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential oder SupportedProtocols vornehmen müssen, müssen diese Änderungen erfolgen, bevor ein erfolgreicher Aufruf der ConnectAsync-Methode im StreamWebSocket erfolgt.

Im folgenden Beispiel wird ein StreamWebSocket erstellt und anschließend veranschaulicht, wie die StreamWebSocketControl.NoDelay-Eigenschaft auf "false" festgelegt wird. (Andere Eigenschaften können auf ähnliche Weise festgelegt werden.) Nachdem dies erfolgt ist, kann die App das StreamWebSocket verbinden.

using Windows.Networking.Sockets;

StreamWebSocket clientWebSocket = new StreamWebSocket();

// Get the current setting for this option.
// This isn't required, but it shows how to get the current setting.
bool currentSetting = clientWebSocket.Control.NoDelay;

// Set NoDelay to false so that the Nagle algorithm is not disabled.
clientWebSocket.Control.NoDelay = false;

// Now you can call the ConnectAsync method to connect the StreamWebSocket.

#include <winrt/Windows.Networking.Sockets.h>
using namespace winrt;
...
Windows::Networking::Sockets::StreamWebSocket clientWebSocket;

// Get the current setting for this option.
// This isn't required, but it shows how to get the current setting.
bool currentSetting{ clientWebSocket.Control().NoDelay() };

// Set NoDelay to false so that the Nagle algorithm is not disabled.
clientWebSocket.Control().NoDelay(false);

// Now you can call the ConnectAsync method to connect the StreamWebSocket.

using namespace Windows::Networking::Sockets;

StreamWebSocket^ clientWebSocket = ref new StreamWebSocket();

// Get the current setting for this option.
// This isn't required, but it shows how to get the current setting .
bool currentSetting = clientWebSocket->Control->NoDelay;

// Set NoDelay to false so that the Nagle algorithm is not disabled.
clientWebSocket->Control->NoDelay = false;

// Now you can call the ConnectAsync method to connect the StreamWebSocket.

Weitere Informationen zur Verwendung von StreamWebSocketControl finden Sie unter Verwenden erweiterter WebSocket-Steuerelemente.

Versionsverlauf

Windows-Version	SDK-Version	Mehrwert
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	Clientzertifikat
1709	16299	DesiredUnsolicitedPongInterval

Eigenschaften

Name	Beschreibung
ActualUnsolicitedPongInterval	Ermöglicht einer App, das tatsächliche unerwünschte WebSocket-PONG-Intervall abzurufen.
ClientCertificate	Ruft das vom Client bereitgestellte Zertifikat ab, wenn eine sichere WebSocket-Verbindung hergestellt wurde.
DesiredUnsolicitedPongInterval	Ermöglicht einer App das Abrufen und Festlegen des gewünschten unerwünschten WebSocket-PONG-Intervalls.
IgnorableServerCertificateErrors	Ruft eine Liste der ignorablen Serverzertifikatfehler ab. Rufen Sie diese Liste ab, und fügen Sie ChainValidationResult-Werte für Serverzertifikatfehler hinzu, die Sie während des Überprüfungsprozesses für sichere WebSocket-Serverzertifikate (wss:// Protokoll) ignorieren möchten.
NoDelay	Ein Wert, der angibt, ob der Nagle-Algorithmus für ein StreamWebSocket -Objekt verwendet wird.
OutboundBufferSizeInBytes	Die Größe des Sendepuffers, der zum Senden von Daten in einem StreamWebSocket-Objekt verwendet werden soll.
ProxyCredential	Die Anmeldeinformationen, die für die Authentifizierung beim Proxyserver über die HTTP-Headerauthentifizierung mithilfe eines StreamWebSocket-Objekts verwendet werden sollen.
ServerCredential	Die Anmeldeinformationen, die für die Authentifizierung beim WebSocket-Server über die HTTP-Headerauthentifizierung mithilfe eines StreamWebSocket-Objekts verwendet werden sollen.
SupportedProtocols	Ruft eine Auflistung ab, die verwendet werden kann, um eine Liste der unterstützten Unterprotokolle hinzuzufügen, die während des Verbindungs handshake an den Server angekündigt werden.