ClientWebSocket.ReceiveAsync Метод

Определение

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

System.Net.WebSockets

Сборка:

System.Net.WebSockets.Client.dll

Перегрузки

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Извлекает данные по ClientWebSocket в виде асинхронной операции.
ReceiveAsync(Memory<Byte>, CancellationToken)	Извлекает данные по ClientWebSocket в виде асинхронной операции.

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Исходный код:

ClientWebSocket.cs

Извлекает данные по ClientWebSocket в виде асинхронной операции.

public:
 override System::Threading::Tasks::Task<System::Net::WebSockets::WebSocketReceiveResult ^> ^ ReceiveAsync(ArraySegment<System::Byte> buffer, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<System.Net.WebSockets.WebSocketReceiveResult> ReceiveAsync (ArraySegment<byte> buffer, System.Threading.CancellationToken cancellationToken);

override this.ReceiveAsync : ArraySegment<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocketReceiveResult>

Public Overrides Function ReceiveAsync (buffer As ArraySegment(Of Byte), cancellationToken As CancellationToken) As Task(Of WebSocketReceiveResult)

Параметры

buffer

ArraySegment<Byte>

Буфер для получения ответа.

cancellationToken

CancellationToken

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

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

Task<WebSocketReceiveResult>

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

Исключения

InvalidOperationException

ClientWebSocket не подключен.

ObjectDisposedException

ClientWebSocket был закрыт.

OperationCanceledException

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

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после завершения запроса на получение в экземпляре ClientWebSocket .

Для каждого ClientWebSocket объекта поддерживается только одна отправка и одно получение в параллельном режиме. Выдача нескольких приемов одновременно не поддерживается и приведет к неопределенному поведению. Следует сериализовать операции получения с помощью любого наиболее подходящего для вас механизма, например с помощью блокировки или семафора.

ReceiveAsync(Memory<Byte>, CancellationToken)

Исходный код:

ClientWebSocket.cs

Извлекает данные по ClientWebSocket в виде асинхронной операции.

public:
 override System::Threading::Tasks::ValueTask<System::Net::WebSockets::ValueWebSocketReceiveResult> ReceiveAsync(Memory<System::Byte> buffer, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.ValueTask<System.Net.WebSockets.ValueWebSocketReceiveResult> ReceiveAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken);

override this.ReceiveAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.WebSockets.ValueWebSocketReceiveResult>

Public Overrides Function ReceiveAsync (buffer As Memory(Of Byte), cancellationToken As CancellationToken) As ValueTask(Of ValueWebSocketReceiveResult)

Параметры

buffer

Memory<Byte>

Область памяти для получения ответа.

cancellationToken

CancellationToken

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

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

ValueTask<ValueWebSocketReceiveResult>

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

Исключения

InvalidOperationException

ClientWebSocket не подключен.

ObjectDisposedException

ClientWebSocket был закрыт.

OperationCanceledException

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

Комментарии

Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после завершения запроса на получение в экземпляре ClientWebSocket .

Для каждого ClientWebSocket объекта поддерживается только одна отправка и одно получение в параллельном режиме. Выдача нескольких приемов одновременно не поддерживается и приведет к неопределенному поведению. Следует сериализовать операции получения с помощью любого наиболее подходящего для вас механизма, например с помощью блокировки или семафора.