ClientWebSocket.ConnectAsync メソッド

定義

名前空間:

System.Net.WebSockets

アセンブリ:

System.Net.WebSockets.Client.dll

オーバーロード

ConnectAsync(Uri, CancellationToken)	非同期操作として WebSocket サーバーに接続します。
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	非同期操作として WebSocket サーバーに接続します。

ConnectAsync(Uri, CancellationToken)

ソース:

ClientWebSocket.cs

非同期操作として 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.Task

Public Function ConnectAsync (uri As Uri, cancellationToken As CancellationToken) As Task

パラメーター

uri

Uri

接続する WebSocket サーバーの URI。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達するために使用されるキャンセル トークン。

戻り値

Task

非同期操作を表すタスク オブジェクト。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

メソッドは 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 バージョンのアップグレード/ダウングレードを有効にするには、オプションとオプションに関するページをHttpVersionPolicy参照してくださいHttpVersion。

ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)

ソース:

ClientWebSocket.cs

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

public:
 System::Threading::Tasks::Task ^ ConnectAsync(Uri ^ uri, System::Net::Http::HttpMessageInvoker ^ invoker, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task ConnectAsync (Uri uri, System.Net.Http.HttpMessageInvoker? invoker, System.Threading.CancellationToken cancellationToken);

member this.ConnectAsync : Uri * System.Net.Http.HttpMessageInvoker * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function ConnectAsync (uri As Uri, invoker As HttpMessageInvoker, cancellationToken As CancellationToken) As Task

パラメーター

uri

Uri

接続する WebSocket サーバーの URI。

invoker

HttpMessageInvoker

HttpMessageInvoker接続に使用するインスタンス。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達するために使用されるキャンセル トークン。

戻り値

Task

非同期操作を表すタスク オブジェクト。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。