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 プロパティを変更する必要がある場合は、StreamWebSocket で ConnectAsync メソッドを正常に呼び出す前に、これらの変更が発生する必要があります。

次の例では、 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	アプリが実際の未承諾 WebSocket PONG 間隔を取得できるようにします。
ClientCertificate	セキュリティで保護された WebSocket 接続が確立されたときにクライアントによって提供される証明書を取得します。
DesiredUnsolicitedPongInterval	アプリが目的の未承諾 WebSocket PONG 間隔を取得および設定できるようにします。
IgnorableServerCertificateErrors	無視できるサーバー証明書エラーの一覧を取得します。 このリストを取得し、セキュリティで保護された WebSocket (wss:// プロトコル) サーバー証明書検証プロセス中に無視するサーバー証明書エラーの ChainValidationResult 値を追加します。
NoDelay	Nagle アルゴリズムが StreamWebSocket オブジェクトで使用されるかどうかを示す値。
OutboundBufferSizeInBytes	StreamWebSocket オブジェクトでデータを送信するために使用される送信バッファーのサイズ (バイト単位)。
ProxyCredential	StreamWebSocket オブジェクトを使用した HTTP ヘッダー認証を使用してプロキシ サーバーに対する認証に使用する資格情報。
ServerCredential	StreamWebSocket オブジェクトを使用した HTTP ヘッダー認証を使用して WebSocket サーバーに対する認証に使用する資格情報。
SupportedProtocols	接続ハンドシェイク中にサーバーにアドバタイズされる、サポートされているサブプロトコルの一覧を追加するために使用できるコレクションを取得します。