MessageWebSocketControl Kelas

Definisi

Ruang nama:

Windows.Networking.Sockets

Menyediakan data kontrol soket pada MessageWebSocket.

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

Warisan

Object Platform::Object IInspectable MessageWebSocketControl

Atribut

ContractVersionAttribute MarshalingBehaviorAttribute

Penerapan

IWebSocketControl IWebSocketControl2

Persyaratan Windows

Rangkaian perangkat	Windows 10 (diperkenalkan dalam 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (diperkenalkan dalam v1.0)

Keterangan

Kelas MessageWebSocketControl menyediakan akses ke data kontrol soket tingkat lanjut pada objek MessageWebSocket .

Objek MessageWebSocketControl secara otomatis dibuat dengan objek MessageWebSocket induk. Properti MessageWebSocket.Control menyediakan akses ke objek MessageWebSocket terkait.

Properti SupportedProtocols mendapatkan nilai properti ini dan dapat dipanggil kapan saja.

Properti MessageType dapat diubah kapan saja sebelum atau sesudah MessageWebSocket tersambung. Ini memungkinkan aplikasi untuk beralih antara pesan biner dan UTF-8 saat diperlukan.

Properti OutboundBufferSizeInBytes harus diatur sebelum MessageWebSocket tersambung. Mengatur properti ini setelah MessageWebSocket tersambung tidak berpengaruh.

Setiap perubahan pada nilai properti lain pada MessageWebSocketControl harus diatur sebelum DatagramSocket terikat atau tersambung. Akibatnya jika Anda perlu membuat perubahan pada properti MaxMessageSize, ProxyCredential, OutboundBufferSizeInBytes, atau ServerCredential , maka perubahan ini harus terjadi sebelum panggilan berhasil ke metode ConnectAsync pada MessageWebSocket.

Contoh berikut membuat MessageWebSocket, lalu menunjukkan cara mengatur properti MessageWebSocketControl.MessageType ke biner. (Properti lain mungkin diatur dengan cara yang sama.) Setelah ini selesai, aplikasi dapat menghubungkan 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.

Untuk informasi selengkapnya tentang menggunakan MessageWebSocketControl, lihat Cara menggunakan kontrol WebSocket tingkat lanjut.

Riwayat versi

Versi Windows	Versi SDK	Nilai ditambahkan
1607	14393	IgnorableServerCertificateErrors
1709	16299	ActualUnsolicitedPongInterval
1709	16299	ClientCertificate
1709	16299	DesiredUnsolicitedPongInterval
1709	16299	ReceiveMode

Properti

ActualUnsolicitedPongInterval	Memungkinkan aplikasi untuk mendapatkan interval PONG WebSocket yang tidak diminta yang sebenarnya.
ClientCertificate	Mendapatkan sertifikat yang disediakan oleh klien ketika koneksi WebSocket aman telah dibuat.
DesiredUnsolicitedPongInterval	Memungkinkan aplikasi untuk mendapatkan dan mengatur interval PONG WebSocket yang tidak diminta yang diinginkan.
IgnorableServerCertificateErrors	Mendapatkan daftar kesalahan sertifikat server yang dapat diabaikan. Dapatkan daftar ini dan tambahkan nilai ChainValidationResult untuk kesalahan sertifikat server yang ingin Anda abaikan selama proses validasi sertifikat server WebSocket (protokol wss:// ) yang aman.
MaxMessageSize	Ukuran pesan maksimum, dalam byte, agar pesan WebSocket dikonfigurasi pada objek MessageWebSocket .
MessageType	Jenis pesan WebSocket yang akan dikonfigurasi pada objek MessageWebSocket untuk operasi tulis.
OutboundBufferSizeInBytes	Ukuran, dalam byte, buffer kirim yang akan digunakan untuk mengirim data pada objek MessageWebSocket .
ProxyCredential	Kredensial yang digunakan untuk mengautentikasi ke server proksi melalui autentikasi header HTTP menggunakan objek MessageWebSocket .
ReceiveMode	Memungkinkan klien mengontrol penerimaan pesan lengkap atau sebagian.
ServerCredential	Kredensial yang digunakan untuk mengautentikasi ke server WebSocket melalui autentikasi header HTTP menggunakan objek MessageWebSocket .
SupportedProtocols	Mendapatkan koleksi yang dapat digunakan untuk menambahkan daftar sub-protokol yang didukung yang akan diiklankan ke server selama jabat tangan koneksi.

Lihat juga

• MessageWebSocket
• Control
• MessageWebSocketInformation
• Cara menggunakan kontrol WebSocket tingkat lanjut
• WebSockets
• Sampel WebSocket