StreamWebSocketControl Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет данные управления сокетом для объекта 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
- Наследование
- Атрибуты
- Реализации
Требования к 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 | ClientCertificate |
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 |
Возвращает коллекцию, которую можно использовать для добавления списка поддерживаемых под-протоколов, которые будут объявлены серверу во время подтверждения подключения. |