MessageWebSocketControl Classe

Définition

Espace de noms:

Windows.Networking.Sockets

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

public ref class MessageWebSocketControl sealed : IWebSocketControl2

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

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

Public NotInheritable Class MessageWebSocketControl
Implements IWebSocketControl2

Héritage

Object Platform::Object IInspectable MessageWebSocketControl

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)

Remarques

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

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

La propriété SupportedProtocols obtient la valeur de cette propriété et peut être appelée à tout moment.

La propriété MessageType peut être modifiée à tout moment avant ou après la connexion de MessageWebSocket . Cela permet à une application de basculer entre les messages binaires et UTF-8 si nécessaire.

La propriété OutboundBufferSizeInBytes doit être définie avant la connexion de MessageWebSocket . La définition de cette propriété après la connexion de MessageWebSocket n’a aucun effet.

Toutes les modifications apportées aux autres valeurs de propriété sur MessageWebSocketControl doivent être définies avant que le DatagramSocket soit lié ou connecté. Par conséquent, si vous devez apporter des modifications aux propriétés MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes ou ServerCredential , ces modifications doivent se produire avant un appel réussi à la méthode ConnectAsync sur messageWebSocket.

L’exemple suivant crée un MessageWebSocket, puis montre comment définir la propriété MessageWebSocketControl.MessageType sur binary. (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 messageWebSocket.

using Windows.Networking.Sockets;

MessageWebSocket clientWebSocket = new MessageWebSocket();

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

// Set messageType to Binary.
clientWebSocket.Control.MessageType = SocketMessageType.Binary;

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

#include <winrt/Windows.Networking.Sockets.h>
using namespace winrt;
...
Windows::Networking::Sockets::MessageWebSocket clientSocket;

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

// Set QualityOfService to Binary.
clientSocket.Control().MessageType(Windows::Networking::Sockets::SocketMessageType::Binary);

// Now you can call the ConnectAsync function to connect the MessageWebSocket.

using namespace Windows::Networking::Sockets;

MessageWebSocket^ clientWebSocket = ref new MessageWebSocket();

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

// Set messageType to Binary.
clientWebSocket->Control->MessageType = SocketMessageType::Binary;

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

Pour plus d’informations sur l’utilisation de MessageWebSocketControl, consultez Comment 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
1709	16299	ReceiveMode

Propriétés

ActualUnsolicitedPongInterval	Permet à une application d’obtenir l’intervalle PONG WebSocket 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 la liste des erreurs de certificat de serveur ignorées. Obtenez cette liste et ajoutez des valeurs ChainValidationResult pour les erreurs de certificat de serveur que vous souhaitez ignorer pendant le processus de validation de certificat de serveur WebSocket (wss:// protocole) sécurisé.
MaxMessageSize	Taille de message maximale, en octets, d’un message WebSocket à configurer sur l’objet MessageWebSocket .
MessageType	Type de message WebSocket à configurer sur un objet MessageWebSocket pour les opérations d’écriture.
OutboundBufferSizeInBytes	Taille, en octets, de la mémoire tampon d’envoi à utiliser pour l’envoi de données sur un objet MessageWebSocket .
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 MessageWebSocket .
ReceiveMode	Permet aux clients de contrôler la réception de messages complets ou partiels.
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 MessageWebSocket .
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.

Voir aussi

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Comment utiliser des contrôles WebSocket avancés
• WebSockets
• Exemple de WebSocket