MessageWebSocketControl Classe

Definição

Namespace:

Windows.Networking.Sockets

Fornece dados de controle de soquete em um 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

Herança

Object Platform::Object IInspectable MessageWebSocketControl

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute

Implementações

IWebSocketControl IWebSocketControl2

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Comentários

A classe MessageWebSocketControl fornece acesso a dados avançados de controle de soquete em um objeto MessageWebSocket .

Um objeto MessageWebSocketControl é criado automaticamente com o objeto MessageWebSocket pai. A propriedade MessageWebSocket.Control fornece acesso ao objeto MessageWebSocket associado.

A propriedade SupportedProtocols obtém o valor dessa propriedade e pode ser chamada a qualquer momento.

A propriedade MessageType pode ser alterada a qualquer momento antes ou depois que o MessageWebSocket estiver conectado. Isso permite que um aplicativo alterne entre mensagens binárias e UTF-8 quando necessário.

A propriedade OutboundBufferSizeInBytes deve ser definida antes que MessageWebSocket esteja conectado. Definir essa propriedade depois que MessageWebSocket estiver conectado não terá efeito.

Quaisquer alterações nos outros valores de propriedade no MessageWebSocketControl devem ser definidas antes que o DatagramSocket seja associado ou conectado. Como resultado, se você precisar fazer alterações nas propriedades MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes ou ServerCredential , essas alterações deverão ocorrer antes de uma chamada bem-sucedida para o método ConnectAsync no MessageWebSocket.

O exemplo a seguir cria um MessageWebSocket e demonstra como definir a propriedade MessageWebSocketControl.MessageType como binária. (Outras propriedades podem ser definidas de maneira semelhante.) Depois que isso for feito, o aplicativo poderá conectar o 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 obter mais informações sobre como usar MessageWebSocketControl, consulte Como usar controles WebSocket avançados.

Histórico de versão

Versão do Windows	Versão do SDK	Valor adicionado
1607	14393	IgnorableServerCertificateErrors
1.709	16299	ActualUnsolicitedPongInterval
1.709	16299	ClientCertificate
1.709	16299	DesiredUnsolicitedPongInterval
1.709	16299	ReceiveMode

Propriedades

ActualUnsolicitedPongInterval	Permite que um aplicativo obtenha o intervalo PONG WebSocket não solicitado real.
ClientCertificate	Obtém o certificado fornecido pelo cliente quando uma conexão WebSocket segura é estabelecida.
DesiredUnsolicitedPongInterval	Permite que um aplicativo obtenha e defina o intervalo de PONG WebSocket não solicitado desejado.
IgnorableServerCertificateErrors	Obtém uma lista de erros de certificado de servidor ignoráveis. Obtenha esta lista e adicione valores ChainValidationResult para erros de certificado de servidor que você deseja ignorar durante o processo de validação de certificado de servidor WebSocket seguro (protocolo wss:// ).
MaxMessageSize	O tamanho máximo da mensagem, em bytes, para que uma mensagem WebSocket seja configurada no objeto MessageWebSocket .
MessageType	O tipo de mensagem WebSocket a ser configurado em um objeto MessageWebSocket para operações de gravação.
OutboundBufferSizeInBytes	O tamanho, em bytes, do buffer de envio a ser usado para enviar dados em um objeto MessageWebSocket .
ProxyCredential	A credencial a ser usada para autenticar no servidor proxy por meio da autenticação de cabeçalho HTTP usando um objeto MessageWebSocket .
ReceiveMode	Permite que os clientes controlem o recebimento de mensagens completas ou parciais.
ServerCredential	A credencial a ser usada para autenticar no servidor WebSocket por meio da autenticação de cabeçalho HTTP usando um objeto MessageWebSocket .
SupportedProtocols	Obtém uma coleção que pode ser usada para adicionar uma lista de sub-protocolos com suporte que serão anunciados ao servidor durante o handshake de conexão.

Confira também

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Como usar controles WebSocket avançados
• WebSockets
• Amostra de WebSocket