ClientWebSocket.ConnectAsync(Uri, CancellationToken) Método

Definição

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 conectar.

cancellationToken
CancellationToken

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

Retornos

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

Exceções

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 subprocurador.

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

Essa 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, consulte HttpVersion a opção e HttpVersionPolicy a opção.

Aplica-se a