WebSocket.ReceiveAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| Имя | Описание |
|---|---|
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Получает данные из WebSocket подключения асинхронно. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Получает данные из WebSocket подключения асинхронно. |
ReceiveAsync(ArraySegment<Byte>, CancellationToken)
Получает данные из WebSocket подключения асинхронно.
public:
abstract System::Threading::Tasks::Task<System::Net::WebSockets::WebSocketReceiveResult ^> ^ ReceiveAsync(ArraySegment<System::Byte> buffer, System::Threading::CancellationToken cancellationToken);
public abstract System.Threading.Tasks.Task<System.Net.WebSockets.WebSocketReceiveResult> ReceiveAsync(ArraySegment<byte> buffer, System.Threading.CancellationToken cancellationToken);
abstract member ReceiveAsync : ArraySegment<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocketReceiveResult>
Public MustOverride Function ReceiveAsync (buffer As ArraySegment(Of Byte), cancellationToken As CancellationToken) As Task(Of WebSocketReceiveResult)
Параметры
- buffer
- ArraySegment<Byte>
Ссылается на буфер приложения, который является расположением хранилища для полученных данных.
- cancellationToken
- CancellationToken
Распространяет уведомление о том, что операции должны быть отменены.
Возвращаемое значение
Объект задачи, представляющий асинхронную операцию. Свойство Result объекта задачи возвращает WebSocketReceiveResult объект, представляющий полученные данные.
Исключения
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
Комментарии
Эта операция не блокируется. Возвращенный Task<TResult> объект завершится после получения данных в объекте WebSocket.
В каждом WebSocket объекте параллельно поддерживается ровно одна отправка и один прием. Выдача нескольких приемов одновременно не поддерживается и приведет к неопределенному поведению. Вы должны сериализовать операции получения с помощью любого механизма, например с помощью блокировки или семафора.
Применяется к
ReceiveAsync(Memory<Byte>, CancellationToken)
Получает данные из WebSocket подключения асинхронно.
public:
virtual System::Threading::Tasks::ValueTask<System::Net::WebSockets::ValueWebSocketReceiveResult> ReceiveAsync(Memory<System::Byte> buffer, System::Threading::CancellationToken cancellationToken);
public virtual System.Threading.Tasks.ValueTask<System.Net.WebSockets.ValueWebSocketReceiveResult> ReceiveAsync(Memory<byte> buffer, System.Threading.CancellationToken cancellationToken);
abstract member ReceiveAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.WebSockets.ValueWebSocketReceiveResult>
override this.ReceiveAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.WebSockets.ValueWebSocketReceiveResult>
Public Overridable Function ReceiveAsync (buffer As Memory(Of Byte), cancellationToken As CancellationToken) As ValueTask(Of ValueWebSocketReceiveResult)
Параметры
Буфер приложения, который является расположением хранилища для полученных данных.
- cancellationToken
- CancellationToken
Маркер отмены, используемый для отмены операции получения.
Возвращаемое значение
Объект задачи, представляющий асинхронную операцию. Свойство Result объекта задачи возвращает ValueWebSocketReceiveResult объект, представляющий полученные данные.
Исключения
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.