StreamWebSocketControl Classe

Définition

Espace de noms:

Windows.Networking.Sockets

Fournit des données de contrôle de socket sur un objet StreamWebSocket .

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

Héritage

Object Platform::Object IInspectable StreamWebSocketControl

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Implémente

IWebSocketControl IWebSocketControl2

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)
Fonctionnalités de l’application	internetClient privateNetworkClientServer

Remarques

La classe StreamWebSocketControl permet d’accéder aux données avancées du contrôle de socket sur un objet StreamWebSocket .

Un objet StreamWebSocketControl est créé automatiquement avec l’objet StreamWebSocket parent. La propriété StreamWebSocket.Control permet d’accéder à l’objet StreamWebSocketControl associé.

Toute modification apportée aux valeurs de propriété StreamWebSocketControl doit être définie avant la connexion de StreamWebSocket . Par conséquent, si vous devez apporter des modifications aux propriétés NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential ou SupportedProtocols , ces modifications doivent se produire avant un appel réussi à la méthode ConnectAsync sur streamWebSocket.

L’exemple suivant crée un StreamWebSocket, puis montre comment définir la propriété StreamWebSocketControl.NoDelay sur false. (D’autres propriétés peuvent être définies de la même manière.) Une fois cette opération effectuée, l’application peut connecter StreamWebSocket.

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.

Pour plus d’informations sur l’utilisation de StreamWebSocketControl, consultez Guide pratique pour utiliser des contrôles WebSocket avancés.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	ClientCertificate
1709	16299	DesiredUnsolicitedPongInterval

Propriétés

ActualUnsolicitedPongInterval	Permet à une application d’obtenir l’intervalle PONG WebSocket réel non sollicité.
ClientCertificate	Obtient le certificat fourni par le client lorsqu’une connexion WebSocket sécurisée a été établie.
DesiredUnsolicitedPongInterval	Permet à une application d’obtenir et de définir l’intervalle PONG WebSocket non sollicité souhaité.
IgnorableServerCertificateErrors	Obtient une liste d’erreurs de certificat de serveur ignorables. Obtenez cette liste et ajoutez des valeurs ChainValidationResult pour les erreurs de certificat de serveur que vous souhaitez ignorer pendant le processus de validation du certificat de serveur WebSocket (protocole wss:// ) sécurisé.
NoDelay	Valeur qui indique si l’algorithme Nagle est utilisé sur un objet StreamWebSocket .
OutboundBufferSizeInBytes	Taille, en octets, de la mémoire tampon d’envoi à utiliser pour envoyer des données sur un objet StreamWebSocket .
ProxyCredential	Informations d’identification à utiliser pour s’authentifier auprès du serveur proxy via l’authentification d’en-tête HTTP à l’aide d’un objet StreamWebSocket .
ServerCredential	Informations d’identification à utiliser pour s’authentifier auprès du serveur WebSocket via l’authentification d’en-tête HTTP à l’aide d’un objet StreamWebSocket .
SupportedProtocols	Obtient une collection qui peut être utilisée pour ajouter une liste de sous-protocoles pris en charge qui seront publiés sur le serveur pendant la négociation de connexion.