StreamWebSocketControl Класс

Определение

Пространство имен:

Windows.Networking.Sockets

Предоставляет данные управления сокетом для объекта 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

Наследование

Object Platform::Object IInspectable StreamWebSocketControl

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute

Реализации

IWebSocketControl IWebSocketControl2

Требования к Windows

Требования	Описание
Семейство устройств	Windows 10 (появилось в 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)
Возможности приложения	internetClient privateNetworkClientServer

Комментарии

Класс StreamWebSocketControl предоставляет доступ к данным расширенного управления сокетами в объекте StreamWebSocket .

Объект StreamWebSocketControl автоматически создается с родительским объектом StreamWebSocket . Свойство StreamWebSocket.Control предоставляет доступ к связанному объекту StreamWebSocketControl.

Все изменения значений свойств StreamWebSocketControl должны быть заданы перед подключением StreamWebSocket . В результате, если необходимо внести изменения в свойства NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential или SupportedProtocols , эти изменения должны возникать перед успешным вызовом метода ConnectAsync в StreamWebSocket.

В следующем примере создается StreamWebSocket, а затем показано, как задать для свойства StreamWebSocketControl.NoDelayзначение false. (Другие свойства могут быть заданы аналогичным образом.) После этого приложение может подключить 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.

Дополнительные сведения об использовании StreamWebSocketControl см. в статье "Использование расширенных элементов управления WebSocket".

Журнал версий

Версия Windows	Версия пакета SDK	Добавленная ценность
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	Сертификат клиента
1709	16299	DesiredUnsolicitedPongInterval

Свойства

Имя.	Описание
ActualUnsolicitedPongInterval	Позволяет приложению получить фактический неопрошенный интервал PONG WebSocket.
ClientCertificate	Возвращает сертификат, предоставленный клиентом при установке безопасного подключения WebSocket.
DesiredUnsolicitedPongInterval	Позволяет приложению получать и задавать нужный неопрошенный интервал PONG WebSocket.
IgnorableServerCertificateErrors	Возвращает список ошибок сертификата сервера, игнорируемых. Получите этот список и добавьте значения ChainValidationResult для ошибок сертификата сервера, которые вы хотите игнорировать во время безопасного процесса проверки сертификата сервера WebSocket (wss:// протокола).
NoDelay	Значение, указывающее, используется ли алгоритм Nagle в объекте StreamWebSocket .
OutboundBufferSizeInBytes	Размер буфера отправки в байтах, используемый для отправки данных в объект StreamWebSocket .
ProxyCredential	Учетные данные, используемые для проверки подлинности на прокси-сервере через проверку подлинности заголовка HTTP с помощью объекта StreamWebSocket .
ServerCredential	Учетные данные, используемые для проверки подлинности на сервере WebSocket с помощью проверки подлинности заголовка HTTP с помощью объекта StreamWebSocket .
SupportedProtocols	Возвращает коллекцию, которую можно использовать для добавления списка поддерживаемых вложенных протоколов, которые будут объявлены серверу во время подтверждения подключения.