ClientWebSocket.ConnectAsync Método

Definición

Espacio de nombres:

System.Net.WebSockets

Ensamblado:

System.Net.WebSockets.Client.dll

Sobrecargas

ConnectAsync(Uri, CancellationToken)	Se conecta a un servidor WebSocket como una operación asincrónica.
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	Se conecta a un servidor WebSocket como una operación asincrónica.

ConnectAsync(Uri, CancellationToken)

Source:

ClientWebSocket.cs

Se conecta a un servidor WebSocket como una operación asincrónica.

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

Parámetros

uri

Uri

URI del servidor de WebSocket al que se conectará.

cancellationToken

CancellationToken

Token de cancelación usado para propagar la notificación de que se debe cancelar la operación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

El ConnectAsync método inicia el protocolo de enlace WebSocket con un destino de red remota y, a continuación, negocia el subprotocolo.

Para las conexiones WebSocket sin formato, use el ws:// esquema en el URI. Para proteger las conexiones WebSocket a través de TLS/SSL, use el wss:// esquema .

Esta operación no se bloqueará. El objeto devuelto Task se completará una vez completada la solicitud de conexión en la ClientWebSocket instancia de .

La solicitud de protocolo de enlace de WebSocket tiene encabezados predeterminados para la solicitud HTTP/1.1:

Connection: Upgrade

Upgrade: websocket

Sec-WebSocket-Key: [generated key]

Para la solicitud HTTP/2:

:protocol: websocket

De forma predeterminada, se usará HTTP/1.1. Para cambiar la versión HTTP usada o habilitar la actualización o degradación de la versión HTTP, consulte HttpVersion la opción y HttpVersionPolicy la opción .

ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)

Source:

ClientWebSocket.cs

Se conecta a un servidor WebSocket como una operación asincrónica.

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

Parámetros

uri

Uri

URI del servidor de WebSocket al que se conectará.

invoker

HttpMessageInvoker

Instancia HttpMessageInvoker que se va a usar para conectarse.

cancellationToken

CancellationToken

Token de cancelación usado para propagar la notificación de que se debe cancelar la operación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.