MessageWebSocketControl Classe

Definizione

Spazio dei nomi:

Windows.Networking.Sockets

Fornisce i dati del controllo socket in 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

Ereditarietà

Object Platform::Object IInspectable MessageWebSocketControl

Attributi

ContractVersionAttribute MarshalingBehaviorAttribute

Implementazioni

IWebSocketControl IWebSocketControl2

Requisiti Windows

Famiglia di dispositivi	Windows 10 (è stato introdotto in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (è stato introdotto in v1.0)

Commenti

La classe MessageWebSocketControl consente di accedere ai dati avanzati del controllo socket in un oggetto MessageWebSocket .

Un oggetto MessageWebSocketControl viene creato automaticamente con l'oggetto MessageWebSocket padre. La proprietà MessageWebSocket.Control consente di accedere all'oggetto MessageWebSocket associato.

La proprietà SupportedProtocols ottiene il valore di questa proprietà e può essere chiamata in qualsiasi momento.

La proprietà MessageType può essere modificata in qualsiasi momento prima o dopo la connessione di MessageWebSocket . In questo modo un'app può passare da un messaggio binario a un messaggio UTF-8 quando necessario.

La proprietà OutboundBufferSizeInBytes deve essere impostata prima della connessione di MessageWebSocket . L'impostazione di questa proprietà dopo la connessione di MessageWebSocket non ha alcun effetto.

Tutte le modifiche apportate agli altri valori di proprietà in MessageWebSocketControl devono essere impostate prima che datagramSocket sia associato o connesso. Di conseguenza, se è necessario apportare modifiche alle proprietà MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes o ServerCredential , queste modifiche devono verificarsi prima di una chiamata corretta al metodo ConnectAsync in MessageWebSocket.

Nell'esempio seguente viene creato un messageWebSocket e viene illustrato come impostare la proprietà MessageWebSocketControl.MessageType su binary. Altre proprietà possono essere impostate in modo simile. Al termine, l'app può connettere 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.

Per altre informazioni sull'uso di MessageWebSocketControl, vedere Come usare i controlli WebSocket avanzati.

Cronologia delle versioni

Versione di Windows	Versione dell'SDK	Valore aggiunto
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	ClientCertificate
1709	16299	DesiredUnsolicitedPongInterval
1709	16299	ReceiveMode

Proprietà

ActualUnsolicitedPongInterval	Consente a un'app di ottenere l'intervallo webSocket PONG non richiesto.
ClientCertificate	Ottiene il certificato fornito dal client quando è stata stabilita una connessione WebSocket sicura.
DesiredUnsolicitedPongInterval	Consente a un'app di ottenere e impostare l'intervallo DI PONG WebSocket desiderato.
IgnorableServerCertificateErrors	Ottiene un elenco di errori di certificato server ignorabili. Ottenere questo elenco e aggiungere valori ChainValidationResult per gli errori del certificato del server che si desidera ignorare durante il processo di convalida del certificato del server WebSocket sicuro (protocollo wss:// ).
MaxMessageSize	Dimensione massima del messaggio, in byte, per la configurazione di un messaggio WebSocket nell'oggetto MessageWebSocket .
MessageType	Tipo di messaggio WebSocket da configurare in un oggetto MessageWebSocket per le operazioni di scrittura.
OutboundBufferSizeInBytes	Dimensioni, in byte, del buffer di invio da utilizzare per l'invio di dati in un oggetto MessageWebSocket .
ProxyCredential	Credenziali da usare per l'autenticazione al server proxy tramite l'autenticazione dell'intestazione HTTP tramite un oggetto MessageWebSocket .
ReceiveMode	Consente ai client di controllare la ricezione di messaggi completi o parziali.
ServerCredential	Credenziali da usare per eseguire l'autenticazione al server WebSocket tramite l'autenticazione dell'intestazione HTTP tramite un oggetto MessageWebSocket .
SupportedProtocols	Ottiene una raccolta che può essere utilizzata per aggiungere un elenco di protocolli secondari supportati che verranno annunciati al server durante l'handshake di connessione.

Vedi anche

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Come usare controlli WebSocket avanzati
• WebSocket
• Esempio WebSocket