ClientWebSocket クラス

定義

WebSocket サービスに接続するためのクライアントを提供します。

public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocket
public sealed class ClientWebSocket : System.Net.WebSockets.WebSocket
type ClientWebSocket = class
    inherit WebSocket
Public NotInheritable Class ClientWebSocket
Inherits WebSocket
継承
ClientWebSocket

注釈

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 の実際の実装を使用して、これらの抽象クラスクラスとクラス要素を継承および拡張できます。

ClientWebSocket オブジェクトでは、1 つの送信と 1 つの受信が並列でサポートされます。 複数の送信または複数の受信を同時に発行することは (たとえば、待機せずに、同期のない複数のスレッドから) サポートされていないため未定義の動作になります。 次の操作を発行する前に、前の操作が待機 (または完了) されていることを確認します。 ロックやセマフォを使用するなど、最適なメカニズムを使用してアクセスをシリアル化する必要があります。

コンストラクター

名前 説明
ClientWebSocket()

ClientWebSocket クラスのインスタンスを作成します。

プロパティ

名前 説明
CloseStatus

ClientWebSocket インスタンスでクローズ ハンドシェイクが開始された理由を取得します。

CloseStatusDescription

ClientWebSocket インスタンスが閉じられた理由の説明を取得します。

Options

ClientWebSocket インスタンスの WebSocket オプションを取得します。

State

ClientWebSocket インスタンスの WebSocket 状態を取得します。

SubProtocol

ClientWebSocket インスタンスでサポートされている WebSocket サブプロトコルを取得します。

メソッド

名前 説明
Abort()

接続を中止し、保留中の IO 操作をすべて取り消します。

CloseAsync(WebSocketCloseStatus, String, CancellationToken)

非同期操作として ClientWebSocket インスタンスを閉じます。

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

ClientWebSocket インスタンスの出力を非同期操作として閉じます。

ConnectAsync(Uri, CancellationToken)

非同期操作として WebSocket サーバーに接続します。

Dispose()

ClientWebSocket インスタンスによって使用されるアンマネージ リソースを解放します。

Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)

ClientWebSocketのデータを非同期操作として受信します。

ReceiveAsync(Memory<Byte>, CancellationToken)

ClientWebSocketのデータを非同期操作として受信します。

SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)

ClientWebSocketのデータを非同期操作として送信します。

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)

ClientWebSocketのデータを読み取り専用バイト メモリ範囲から非同期操作として送信します。

ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象