Compartilhar via


StreamWebSocketControl Classe

Definição

Fornece dados de controle de soquete em um objeto StreamWebSocket .

public ref class StreamWebSocketControl sealed
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
/// [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
[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
Public NotInheritable Class StreamWebSocketControl
Implements IWebSocketControl2
Herança
Object Platform::Object IInspectable StreamWebSocketControl
Atributos
Implementações

Requisitos do Windows

Família de dispositivos
Windows 10 (introduzida na 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduzida na v1.0)
Funcionalidades do aplicativo
internetClient privateNetworkClientServer

Comentários

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

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

Todas as alterações nos valores da propriedade StreamWebSocketControl devem ser definidas antes que o StreamWebSocket seja conectado. Como resultado, se você precisar fazer alterações nas propriedades NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential ou SupportedProtocols , essas alterações deverão ocorrer antes de uma chamada bem-sucedida para o método ConnectAsync no StreamWebSocket.

O exemplo a seguir cria um StreamWebSocket e demonstra como definir a propriedade StreamWebSocketControl.NoDelay como false. (Outras propriedades podem ser definidas de maneira semelhante.) Depois que isso for feito, o aplicativo poderá conectar o 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 obter mais informações sobre como usar StreamWebSocketControl, 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

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:// ).

NoDelay

Um valor que indica se o algoritmo Nagle é usado em um objeto StreamWebSocket .

OutboundBufferSizeInBytes

O tamanho, em bytes, do buffer de envio a ser usado para enviar dados em um objeto StreamWebSocket .

ProxyCredential

A credencial a ser usada para autenticar no servidor proxy por meio da autenticação de cabeçalho HTTP usando um objeto StreamWebSocket .

ServerCredential

A credencial a ser usada para autenticar no servidor WebSocket por meio da autenticação de cabeçalho HTTP usando um objeto StreamWebSocket .

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.

Aplica-se a