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 連線，請使用 ws:// URI 中的配置。 如需透過 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 選項。

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

取消標記已取消。 此例外狀況會儲存在傳回的工作中。