ClientWebSocket.ConnectAsync Метод

Определение

Пространство имен:

System.Net.WebSockets

Сборки:

netstandard.dll, 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

URI сервера WebSocket для подключения.

cancellationToken

CancellationToken

Маркер отмены, используемый для распространения уведомлений о том, что операция должна быть отменена.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Метод ConnectAsync инициирует подтверждение WebSocket с удаленным назначением сети, а затем согласовывает вложенный протокол.

Для обычных подключений WebSocket используйте схему ws:// в URI. Для безопасных подключений WebSocket по протоколу TLS/SSL используйте схему 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

URI сервера WebSocket для подключения.

invoker

HttpMessageInvoker

Экземпляр, используемый HttpMessageInvoker для подключения.

cancellationToken

CancellationToken

Маркер отмены, используемый для распространения уведомлений о том, что операция должна быть отменена.

Возвращаемое значение

Task

Объект задачи, представляющий асинхронную операцию.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.