ClientWebSocket.ConnectAsync 方法

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.Client.dll

重载

ConnectAsync(Uri, CancellationToken)	作为异步操作连接到 WebSocket 服务器。
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	作为异步操作连接到 WebSocket 服务器。

ConnectAsync(Uri, CancellationToken)

Source:

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:// 方案。

此操作不会阻止。 在实例上的连接请求完成后，ClientWebSocket返回Task的对象将完成。

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)

Source:

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

取消令牌已取消。 此异常存储在返回的任务中。