ClientWebSocket.ConnectAsync(Uri, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
非同期操作として WebSocket サーバーに接続します。
public:
System::Threading::Tasks::Task ^ ConnectAsync(Uri ^ uri, System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task ConnectAsync(Uri uri, System.Threading.CancellationToken cancellationToken);member this.ConnectAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function ConnectAsync (uri As Uri, cancellationToken As CancellationToken) As Taskパラメーター
- uri
- Uri
接続先の WebSocket サーバーの URI。
- cancellationToken
- CancellationToken
操作を取り消す必要があることを示す通知を伝達するために使用されるキャンセル トークン。
返品
非同期操作を表すタスク オブジェクト。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
ConnectAsync メソッドは、リモート ネットワーク宛先との WebSocket ハンドシェイクを開始し、サブプロトコルをネゴシエートします。
プレーン WebSocket 接続の場合は、uri で ws:// スキームを使用します。 TLS/SSL 経由のセキュリティで保護された WebSocket 接続の場合は、 wss:// スキームを使用します。
この操作はブロックされません。 返された Task オブジェクトは、 ClientWebSocket インスタンスの接続要求が完了した後に完了します。
WebSocket ハンドシェイク要求には、HTTP/1.1 要求の既定のヘッダーがあります。
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Key: [generated key]
HTTP/2 要求の場合:
:protocol: websocket
既定では、HTTP/1.1 が使用されます。 使用されている HTTP バージョンを変更するか、HTTP バージョンのアップグレード/ダウングレードを有効にするには、 HttpVersion オプションと HttpVersionPolicy オプションを参照してください。