MessageWebSocketControl Clase

Definición

Espacio de nombres:

Windows.Networking.Sockets

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

Herencia

Object Platform::Object IInspectable MessageWebSocketControl

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)

Comentarios

La clase MessageWebSocketControl proporciona acceso a datos de control de socket avanzados en un objeto MessageWebSocket .

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

La propiedad SupportedProtocols obtiene el valor de esta propiedad y se puede llamar en cualquier momento.

La propiedad MessageType se puede cambiar en cualquier momento antes o después de que se conecte MessageWebSocket . Esto permite que una aplicación cambie entre mensajes binarios y UTF-8 cuando sea necesario.

La propiedad OutboundBufferSizeInBytes debe establecerse antes de que se conecte MessageWebSocket . Establecer esta propiedad después de que messageWebSocket esté conectado no tiene ningún efecto.

Los cambios realizados en los demás valores de propiedad en MessageWebSocketControl deben establecerse antes de que DatagramSocket esté enlazado o conectado. Como resultado, si necesita realizar cambios en las propiedades MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes o ServerCredential , estos cambios deben producirse antes de una llamada correcta al método ConnectAsync en messageWebSocket.

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

Para obtener más información sobre el uso de MessageWebSocketControl, vea Cómo usar 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
1709	16299	ReceiveMode

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).
MaxMessageSize	Tamaño máximo del mensaje, en bytes, para que un mensaje WebSocket se configure en el objeto MessageWebSocket .
MessageType	Tipo de mensaje WebSocket que se va a configurar en un objeto MessageWebSocket para operaciones de escritura.
OutboundBufferSizeInBytes	Tamaño, en bytes, del búfer de envío que se va a usar para enviar datos en un objeto MessageWebSocket .
ProxyCredential	Credencial que se va a usar para autenticarse en el servidor proxy mediante la autenticación de encabezado HTTP mediante un objeto MessageWebSocket .
ReceiveMode	Permite a los clientes controlar la recepción de mensajes completos o parciales.
ServerCredential	Credencial que se va a usar para autenticarse en el servidor WebSocket mediante la autenticación de encabezado HTTP mediante un objeto MessageWebSocket .
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.

Consulte también

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Uso de controles avanzados de WebSocket
• WebSockets
• Ejemplo de WebSocket