StreamWebSocketControl Classe

Definizione

Spazio dei nomi:

Windows.Networking.Sockets

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

Ereditarietà

Object Platform::Object IInspectable StreamWebSocketControl

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)
Funzionalità dell'app	internetClient privateNetworkClientServer

Commenti

La classe StreamWebSocketControl consente di accedere ai dati avanzati del controllo socket in un oggetto StreamWebSocket .

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

Le modifiche apportate ai valori delle proprietà StreamWebSocketControl devono essere impostate prima della connessione di StreamWebSocket . Di conseguenza, se è necessario apportare modifiche alle proprietà NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential o SupportedProtocols , queste modifiche devono verificarsi prima di una chiamata corretta al metodo ConnectAsync in StreamWebSocket.

L'esempio seguente crea un oggetto StreamWebSocket e quindi illustra come impostare la proprietà StreamWebSocketControl.NoDelaysu false. Altre proprietà possono essere impostate in modo simile. Al termine, l'app può connettere 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.

Per altre informazioni sull'uso di StreamWebSocketControl, 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

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:// ).
NoDelay	Valore che indica se l'algoritmo Nagle viene utilizzato in un oggetto StreamWebSocket .
OutboundBufferSizeInBytes	Dimensione, in byte, del buffer di invio da usare per l'invio di dati in un oggetto StreamWebSocket .
ProxyCredential	Credenziali da usare per l'autenticazione al server proxy tramite l'autenticazione dell'intestazione HTTP tramite un oggetto StreamWebSocket .
ServerCredential	Credenziali da usare per l'autenticazione al server WebSocket tramite l'autenticazione dell'intestazione HTTP tramite un oggetto StreamWebSocket .
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.