MessageWebSocketControl Klasse

Definition

Namespace:

Windows.Networking.Sockets

Stellt Socketsteuerelementdaten für ein MessageWebSocket bereit.

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

Vererbung

Object Platform::Object IInspectable MessageWebSocketControl

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute

Implementiert

IWebSocketControl IWebSocketControl2

Windows-Anforderungen

Anforderungen	Beschreibung
Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Hinweise

Die MessageWebSocketControl-Klasse bietet Zugriff auf erweiterte Socketsteuerelementdaten in einem MessageWebSocket-Objekt .

Ein MessageWebSocketControl-Objekt wird automatisch mit dem übergeordneten MessageWebSocket-Objekt erstellt. Die MessageWebSocket.Control-Eigenschaft bietet Zugriff auf das zugeordnete MessageWebSocket-Objekt .

Die SupportedProtocols-Eigenschaft ruft den Wert dieser Eigenschaft ab und kann jederzeit aufgerufen werden.

Die MessageType-Eigenschaft kann jederzeit vor oder nach der Verbindung des MessageWebSocket geändert werden. Auf diese Weise kann eine App bei Bedarf zwischen binären und UTF-8-Nachrichten wechseln.

Die OutboundBufferSizeInBytes-Eigenschaft muss festgelegt werden, bevor das MessageWebSocket verbunden ist. Wenn Sie diese Eigenschaft festlegen, nachdem das MessageWebSocket verbunden ist, hat keine Auswirkung.

Alle Änderungen an den anderen Eigenschaftswerten für MessageWebSocketControl müssen festgelegt werden, bevor das DatagramSocket gebunden oder verbunden ist. Wenn Sie daher Änderungen an den Eigenschaften "MaxMessageSize", "ProxyCredential", "OutboundBufferSizeInBytes" oder " ServerCredential " vornehmen müssen, müssen diese Änderungen vor einem erfolgreichen Aufruf der ConnectAsync-Methode im MessageWebSocket auftreten.

Im folgenden Beispiel wird ein MessageWebSocket erstellt und anschließend veranschaulicht, wie die MessageWebSocketControl.MessageType-Eigenschaft auf binär festgelegt wird. (Andere Eigenschaften können auf ähnliche Weise festgelegt werden.) Nachdem dies erfolgt ist, kann die App das MessageWebSocket verbinden.

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.

Weitere Informationen zur Verwendung von MessageWebSocketControl finden Sie unter Verwenden erweiterter WebSocket-Steuerelemente.

Versionsverlauf

Windows-Version	SDK-Version	Mehrwert
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	Clientzertifikat
1709	16299	DesiredUnsolicitedPongInterval
1709	16299	ReceiveMode

Eigenschaften

Name	Beschreibung
ActualUnsolicitedPongInterval	Ermöglicht einer App, das tatsächliche unerwünschte WebSocket-PONG-Intervall abzurufen.
ClientCertificate	Ruft das vom Client bereitgestellte Zertifikat ab, wenn eine sichere WebSocket-Verbindung hergestellt wurde.
DesiredUnsolicitedPongInterval	Ermöglicht einer App das Abrufen und Festlegen des gewünschten unerwünschten WebSocket-PONG-Intervalls.
IgnorableServerCertificateErrors	Ruft eine Liste der ignorablen Serverzertifikatfehler ab. Rufen Sie diese Liste ab, und fügen Sie ChainValidationResult-Werte für Serverzertifikatfehler hinzu, die Sie während des Überprüfungsprozesses für sichere WebSocket-Serverzertifikate (wss:// Protokoll) ignorieren möchten.
MaxMessageSize	Die maximale Nachrichtengröße in Bytes für eine WebSocket-Nachricht, die für das MessageWebSocket-Objekt konfiguriert werden soll.
MessageType	Der WebSocket-Nachrichtentyp, der für ein MessageWebSocket-Objekt für Schreibvorgänge konfiguriert werden soll.
OutboundBufferSizeInBytes	Die Größe des Sendepuffers in Bytes, der zum Senden von Daten in einem MessageWebSocket-Objekt verwendet werden soll.
ProxyCredential	Die Anmeldeinformationen, die für die Authentifizierung beim Proxyserver über die HTTP-Headerauthentifizierung mithilfe eines MessageWebSocket-Objekts verwendet werden sollen.
ReceiveMode	Ermöglicht Es Clients, den Empfang von vollständigen oder teilweisen Nachrichten zu steuern.
ServerCredential	Die Anmeldeinformationen, die für die Authentifizierung beim WebSocket-Server über die HTTP-Headerauthentifizierung mithilfe eines MessageWebSocket-Objekts verwendet werden sollen.
SupportedProtocols	Ruft eine Auflistung ab, die verwendet werden kann, um eine Liste der unterstützten Unterprotokolle hinzuzufügen, die während des Verbindungs handshake an den Server angekündigt werden.

Siehe auch

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Verwenden erweiterter WebSocket-Steuerelemente
• WebSockets
• WebSocket-Beispiel