Поделиться через


MessageWebSocketControl Класс

Определение

Предоставляет данные управления сокетом в MessageWebSocket.

public ref class MessageWebSocketControl sealed
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
/// [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
[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
Public NotInheritable Class MessageWebSocketControl
Implements IWebSocketControl2
Наследование
Object Platform::Object IInspectable MessageWebSocketControl
Атрибуты
Реализации

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

Семейство устройств
Windows 10 (появилось в 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (появилось в v1.0)

Комментарии

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

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

Свойство SupportedProtocols получает значение этого свойства и может вызываться в любое время.

Свойство MessageType можно изменить в любое время до или после подключения MessageWebSocket . Это позволяет приложению переключаться между двоичными сообщениями и сообщениями UTF-8 при необходимости.

Перед подключением MessageWebSocket необходимо задать свойство OutboundBufferSizeInBytes. Установка этого свойства после подключения MessageWebSocket не оказывает никакого влияния.

Любые изменения других значений свойств в MessageWebSocketControl должны быть заданы перед привязкой или подключением DatagramSocket . В результате, если необходимо внести изменения в свойства MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes или ServerCredential , эти изменения должны произойти до успешного вызова метода ConnectAsync в MessageWebSocket.

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

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

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

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

Свойства

ActualUnsolicitedPongInterval

Позволяет приложению получить фактический незапрошенный интервал PONG WebSocket.

ClientCertificate

Возвращает сертификат, предоставленный клиентом при установке безопасного подключения WebSocket.

DesiredUnsolicitedPongInterval

Позволяет приложению получить и задать нужный незапрошенный интервал PONG WebSocket.

IgnorableServerCertificateErrors

Возвращает список ошибок игнорируемых сертификатов сервера. Получите этот список и добавьте значения ChainValidationResult для ошибок сертификата сервера, которые вы хотите игнорировать во время безопасного процесса проверки сертификата сервера WebSocket (wss:// протокол).

MaxMessageSize

Максимальный размер сообщения в байтах для сообщения WebSocket, настраиваемого в объекте MessageWebSocket .

MessageType

Тип сообщения WebSocket, который необходимо настроить в объекте MessageWebSocket для операций записи.

OutboundBufferSizeInBytes

Размер (в байтах) буфера отправки, используемого для отправки данных в объекте MessageWebSocket .

ProxyCredential

Учетные данные, используемые для проверки подлинности на прокси-сервере с помощью проверки подлинности заголовка HTTP с помощью объекта MessageWebSocket .

ReceiveMode

Позволяет клиентам управлять получением полных или частичных сообщений.

ServerCredential

Учетные данные, используемые для проверки подлинности на сервере WebSocket с помощью http-заголовка с помощью объекта MessageWebSocket .

SupportedProtocols

Возвращает коллекцию, которую можно использовать для добавления списка поддерживаемых под-протоколов, которые будут объявлены серверу во время подтверждения подключения.

Применяется к

См. также раздел