StreamWebSocketControl Clase

Definición

Espacio de nombres:

Windows.Networking.Sockets

Proporciona datos de control de socket en un objeto 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

Herencia

Object Platform::Object IInspectable StreamWebSocketControl

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute

Implementaciones

IWebSocketControl IWebSocketControl2

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)
Características de aplicaciones	internetClient privateNetworkClientServer

Comentarios

La clase StreamWebSocketControl proporciona acceso a datos avanzados de control de socket en un objeto StreamWebSocket .

Un objeto StreamWebSocketControl se crea automáticamente con el objeto primario StreamWebSocket . La propiedad StreamWebSocket.Control proporciona acceso al objeto StreamWebSocketControl asociado.

Los cambios realizados en los valores de propiedad StreamWebSocketControl deben establecerse antes de que se conecte StreamWebSocket . Como resultado, si necesita realizar cambios en las propiedades NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential o SupportedProtocols , estos cambios deben producirse antes de una llamada correcta al método ConnectAsync en StreamWebSocket.

En el ejemplo siguiente se crea un objeto StreamWebSocket y, a continuación, se muestra cómo establecer la propiedad StreamWebSocketControl.NoDelay en false. (Otras propiedades se pueden establecer de forma similar). Una vez hecho esto, la aplicación puede conectar 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.

Para obtener más información sobre el uso de StreamWebSocketControl, consulte Uso de controles WebSocket avanzados.

Historial de versiones

Versión de Windows	Versión del SDK	Valor agregado
1607	14393	IgnoreableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	ClientCertificate
1709	16299	DesiredUnsolicitedPongInterval

Propiedades

ActualUnsolicitedPongInterval	Permite que una aplicación obtenga el intervalo real de WebSocket PONG no solicitado.
ClientCertificate	Obtiene el certificado proporcionado por el cliente cuando se ha establecido una conexión WebSocket segura.
DesiredUnsolicitedPongInterval	Permite que una aplicación obtenga y establezca el intervalo de PONG no solicitado deseado de WebSocket.
IgnorableServerCertificateErrors	Obtiene una lista de errores de certificado de servidor ignorables. Obtenga esta lista y agregue los valores ChainValidationResult para los errores de certificado de servidor que desea omitir durante el proceso seguro de validación de certificados de servidor de WebSocket (wss:// protocolo).
NoDelay	Valor que indica si el algoritmo nagle se usa en un objeto StreamWebSocket .
OutboundBufferSizeInBytes	Tamaño, en bytes, del búfer de envío que se va a usar para enviar datos en un objeto StreamWebSocket .
ProxyCredential	Credencial que se va a usar para autenticarse en el servidor proxy mediante la autenticación de encabezado HTTP mediante un objeto StreamWebSocket .
ServerCredential	Credencial que se va a usar para autenticarse en el servidor WebSocket mediante la autenticación de encabezado HTTP mediante un objeto StreamWebSocket .
SupportedProtocols	Obtiene una colección que se puede usar para agregar una lista de los sub-protocolos admitidos que se anunciarán en el servidor durante el protocolo de enlace de conexión.