WebSocket クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
WebSocket クラスを使用すると、アプリケーションは WebSocket のアップグレードが完了した後にデータを送受信できます。
public ref class WebSocket abstract : IDisposablepublic abstract class WebSocket : IDisposabletype WebSocket = class
interface IDisposablePublic MustInherit Class WebSocket
Implements IDisposable- 継承
-
WebSocket
- 派生
- 実装
注釈
System.Net.WebSockets 名前空間のクラスの一部は、Windows 7、Windows Vista SP2、および Windows Server 2008 でサポートされています。 ただし、クライアントとサーバーの WebSocket の唯一のパブリック実装は、Windows 8とWindows Server 2012でサポートされています。 Windows 7、Windows Vista SP2、Windows Server 2008 でサポートされている System.Net.WebSockets 名前空間のクラスとクラス要素は抽象クラスです。 これにより、アプリケーション開発者は、クライアント WebSocket の実際の実装を使用して、これらの抽象クラスを継承および拡張できます。
各 WebSocket オブジェクトでは、1 つの送信と 1 つの受信が並列でサポートされます。 複数の送信または複数の受信を同時に発行することは (たとえば、待機せずに、同期のない複数のスレッドから) サポートされていないため 、 未定義の動作になります。 次の操作を発行する前に、前の操作が待機 (または完了) されていることを確認します。 ロックやセマフォを使用するなど、最適なメカニズムを使用してアクセスをシリアル化します。
コンストラクター
| 名前 | 説明 |
|---|---|
| WebSocket() |
WebSocket クラスのインスタンスを作成します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| CloseStatus |
リモート エンドポイントがクローズ ハンドシェイクを開始した理由を示します。 |
| CloseStatusDescription |
リモート エンドポイントが接続を閉じた理由を説明できるようにします。 |
| DefaultKeepAliveInterval |
既定の WebSocket プロトコルのキープアライブ間隔を取得します。 |
| State |
WebSocket 接続の現在の状態を返します。 |
| SubProtocol |
開始ハンドシェイク中にネゴシエートされたサブプロトコルを取得します。 |
メソッド
| 名前 | 説明 |
|---|---|
| Abort() |
WebSocket 接続を中止し、保留中の IO 操作をすべて取り消します。 |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
WebSocket プロトコル仕様セクション 7 で定義されているクローズ ハンドシェイクを使用して、非同期操作として WebSocket 接続を閉じます。 |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
WebSocket プロトコル仕様セクション 7 で定義されているクローズ ハンドシェイクを開始または完了します。 |
| CreateClientBuffer(Int32, Int32) |
この WebSocket インスタンスで使用するクライアント バッファーを作成します。 |
| CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>) |
この API は製品インフラストラクチャをサポートします。コードから直接使用するものではありません。 呼び出し元が、フレーム化のために WSPC を使用するクライアント側の WebSocket クラスを作成できるようにします。 |
| CreateFromStream(Stream, Boolean, String, TimeSpan) |
Web ソケット接続を表す、指定したストリームで動作する新しい WebSocket オブジェクトを作成します。 |
| CreateServerBuffer(Int32) |
WebSocket サーバー バッファーを作成します。 |
| Dispose() |
ASP.NET およびセルフホステッド実装のアンマネージ リソースをクリーンアップするために使用されます。 |
| Equals(Object) |
指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
| GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
| GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
| IsApplicationTargeting45() |
古い.
古い.
WebSocket インスタンスが Framework 4.5 を対象としているかどうかを示す値.NET返します。 |
| IsStateTerminal(WebSocketState) |
WebSocket インスタンスの状態が閉じているか中止されるかを示す値を返します。 |
| MemberwiseClone() |
現在の Objectの簡易コピーを作成します。 (継承元 Object) |
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
WebSocket接続から非同期的にデータを受信します。 |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
WebSocket接続から非同期的にデータを受信します。 |
| RegisterPrefixes() |
この API は製品インフラストラクチャをサポートします。コードから直接使用するものではありません。 呼び出し元が WebSocket 要求 (ws および wss) のプレフィックスを登録できるようにします。 |
| SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
WebSocket接続経由で非同期的にデータを送信します。 |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
WebSocket接続経由で非同期的にデータを送信します。 |
| ThrowOnInvalidState(WebSocketState, WebSocketState[]) |
接続が予期された状態であることを確認します。 |
| ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Object) |