WebSocket.ReceiveAsync Метод

Определение

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

System.Net.WebSockets

Сборка:

System.Net.WebSockets.dll

Перегрузки

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Асинхронно получает данные через соединение WebSocket.
ReceiveAsync(Memory<Byte>, CancellationToken)	Асинхронно получает данные через соединение WebSocket.

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

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

WebSocket.cs

Асинхронно получает данные через соединение 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

Распространяет уведомление о том, что операции следует отменить.

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

Task<WebSocketReceiveResult>

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

Исключения

OperationCanceledException

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

Комментарии

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

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

ReceiveAsync(Memory<Byte>, CancellationToken)

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

WebSocket.cs

Асинхронно получает данные через соединение 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)

Параметры

buffer

Memory<Byte>

Буфер приложения, который является местом хранения полученных данных.

cancellationToken

CancellationToken

Токен отмены для отмены операции получения.

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

ValueTask<ValueWebSocketReceiveResult>

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

Исключения

OperationCanceledException

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