StreamWebSocket クラス

  • リファレンス

定義

名前空間:
Windows.Networking.Sockets
編集

WebSocket を使用したストリームの読み取りと書き込みを可能にするネットワーク通信をサポートします。

public ref class StreamWebSocket sealed : IClosable
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class StreamWebSocket final : IClosable
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class StreamWebSocket final : IClosable
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class StreamWebSocket : System.IDisposable
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class StreamWebSocket : System.IDisposable
function StreamWebSocket()
Public NotInheritable Class StreamWebSocket
Implements IDisposable
継承
Object Platform::Object IInspectable StreamWebSocket
属性
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
実装
IClosable IDisposable IWebSocket

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能
internetClient privateNetworkClientServer

注釈

StreamWebSocket クラスは、メッセージ ベースの WebSocket プロトコルのストリームベースの抽象化を提供します。 これは、大きなファイル (写真や映画など) を転送する必要があるシナリオに役立ちます。 StreamWebSocket を使用すると、( MessageWebSocket と同様に) 1 つの操作でメッセージ全体を読み取る必要はなく、各読み取り操作でメッセージのセクションを読み取ることができます。

StreamWebSocket はバイナリ メッセージのみをサポートします。 UTF-8 メッセージの場合は、 MessageWebSocket を使用する必要があります。

例外の処理

StreamWebSocket クラスで非同期メソッドを呼び出すときに例外を処理するコードを記述する必要があります。 例外は、パラメーター検証エラー、名前解決エラー、ネットワーク エラーによって発生する可能性があります。 ネットワーク エラーの例外 (接続の損失、接続エラー、HTTP サーバーの障害など) は、いつでも発生する可能性があります。 これらのエラーが起きると、例外がスローされます。 アプリによって処理されない場合、例外によってアプリ全体がランタイムによって終了する可能性があります。

Windows.Networking.Sockets 名前空間には、WebSocket を使用するときにエラーを処理するための便利なヘルパー メソッドと列挙があります。 これは、アプリで特定のネットワーク例外を異なる方法で処理する場合に役立つことがあります。 アプリでは、パラメーター検証エラーの例外から HRESULT を使用して、例外の原因となったエラーの詳細を確認することもできます。

考えられる例外と例外の処理方法の詳細については、「 ネットワーク アプリでの例外の処理」を参照してください。

Windows Server 2012での StreamWebSocket の使用

Windows Server 2012 および Windows Server 2012 R2 では、Media Foundation 機能が有効になっていない限り、Windows.Networking.Sockets 名前空間のほとんどのクラスを実装するWindows.Networking.dllは読み込みに失敗します。 その結果、Media Foundation 機能が無効になっている場合、 Windows.Networking.Sockets 名前空間で StreamWebSocket および関連する WebSocket クラスを使用するアプリは失敗します。 Windows Server 2012または Windows Server 2012 R2 は Media Foundation 機能を無効にしてインストールします。

Media Foundation 機能は、サーバー マネージャーを使用するか、コマンド プロンプトまたはスクリプトに次のテキストを入力して、Windows Server 2012または Windows Server 2012 R2 で有効にすることができます。

dism /online /enable-feature /featurename:ServerMediaFoundation Media Foundation 機能を有効にすると、ユーザーは再起動を求められます。 コンピューターが再起動されると、 Windows.Networking.Sockets 名前空間のソケットと WebSocket のクラスが期待どおりに動作します。

バージョン履歴

Windows のバージョン SDK バージョン 追加された値
1607 14393 ServerCustomValidationRequested

コンストラクター

StreamWebSocket()

新しい StreamWebSocket オブジェクトを 作成します。

プロパティ

Control

StreamWebSocket オブジェクトのソケット コントロール データを取得します。
Information

StreamWebSocket オブジェクトのソケット情報を取得します。
InputStream

StreamWebSocket オブジェクトのリモート変換先から読み取る入力ストリームを取得します。
OutputStream

StreamWebSocket オブジェクトのリモート ネットワーク宛先に書き込む出力ストリームを取得します。

メソッド

Close()

StreamWebSocket を閉じ、空の閉じるフレームをサーバーに送信します。
Close(UInt16, String)

StreamWebSocket を閉じ、閉じる理由を示します。
ConnectAsync(Uri)

StreamWebSocket オブジェクトのリモート ネットワーク宛先に接続するための非同期操作を開始します。
Dispose()

アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。
SetRequestHeader(String, String)

StreamWebSocket オブジェクトによって WebSocket プロトコル ハンドシェイクで使用される HTTP 要求メッセージに HTTP 要求ヘッダーを追加します。

イベント

Closed

閉じるハンドシェイクの一部として StreamWebSocket オブジェクトで閉じるフレームを受信したときに発生します。
ServerCustomValidationRequested

セキュリティで保護されたサーバー URI (wss: プロトコル) への新しい StreamWebSocket 接続が検証されるときに発生します。 接続のカスタム サーバー検証を実装する場合は、このイベントを処理します。

適用対象

こちらもご覧ください