ClientWebSocket.ConnectAsync Método

Definição

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.Client.dll

Sobrecargas

ConnectAsync(Uri, CancellationToken)	Conecta-se a um servidor WebSocket como uma operação assíncrona.
ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)	Conecta-se a um servidor WebSocket como uma operação assíncrona.

ConnectAsync(Uri, CancellationToken)

Origem:

ClientWebSocket.cs

Conecta-se a um servidor WebSocket como uma operação assíncrona.

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

O URI do servidor WebSocket ao qual se deve conectar.

cancellationToken

CancellationToken

Um token de cancelamento usado para propagar a notificação de que a operação deve ser cancelada.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

O ConnectAsync método inicia o handshake do WebSocket com um destino de rede remota e negocia o subpro protocolo.

Para conexões WebSocket simples, use o ws:// esquema no URI. Para conexões WebSocket seguras por TLS/SSL, use o wss:// esquema .

Esta operação não será bloqueada. O objeto retornado Task será concluído após a conclusão da solicitação de conexão na ClientWebSocket instância.

A solicitação de handshake do WebSocket tem cabeçalhos padrão para solicitação HTTP/1.1:

Connection: Upgrade

Upgrade: websocket

Sec-WebSocket-Key: [generated key]

Para solicitação HTTP/2:

:protocol: websocket

Por padrão, HTTP/1.1 será usado. Para alterar a versão HTTP usada ou habilitar a atualização/downgrade da versão HTTP, confira HttpVersion opção e HttpVersionPolicy opção.

ConnectAsync(Uri, HttpMessageInvoker, CancellationToken)

Origem:

ClientWebSocket.cs

Conecta-se a um servidor WebSocket como uma operação assíncrona.

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

O URI do servidor WebSocket ao qual se deve conectar.

invoker

HttpMessageInvoker

A HttpMessageInvoker instância a ser usada para conexão.

cancellationToken

CancellationToken

Um token de cancelamento usado para propagar a notificação de que a operação deve ser cancelada.

Retornos

Task

O objeto de tarefa que representa a operação assíncrona.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.