WebSocket.ReceiveAsync Método

Definição

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Sobrecargas

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Recebe dados da conexão WebSocket de forma assíncrona.
ReceiveAsync(Memory<Byte>, CancellationToken)	Recebe dados da conexão WebSocket de forma assíncrona.

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Origem:

WebSocket.cs

Recebe dados da conexão WebSocket de forma assíncrona.

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)

Parâmetros

buffer

ArraySegment<Byte>

Referencia o buffer de aplicativo que é o local de armazenamento dos dados recebidos.

cancellationToken

CancellationToken

Propaga a notificação de que as operações devem ser canceladas.

Retornos

Task<WebSocketReceiveResult>

O objeto de tarefa que representa a operação assíncrona. A propriedade Result no objeto da tarefa retorna um objeto WebSocketReceiveResult que representa os dados recebidos.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Essa operação não será bloqueada. O objeto retornado Task<TResult> será concluído depois que os dados forem recebidos no WebSocket.

Há suporte para exatamente um envio e um recebimento em cada WebSocket objeto em paralelo. Não há suporte para a emissão de vários recebimentos ao mesmo tempo e resultará em um comportamento indefinido. Você deve serializar operações de recebimento por meio de qualquer mecanismo que funcione melhor para você, por exemplo, usando um bloqueio ou um semáforo.

ReceiveAsync(Memory<Byte>, CancellationToken)

Origem:

WebSocket.cs

Recebe dados da conexão WebSocket de forma assíncrona.

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)

Parâmetros

buffer

Memory<Byte>

O buffer de aplicativo que é o local de armazenamento dos dados recebidos.

cancellationToken

CancellationToken

O token de cancelamento a ser usado para cancelar a operação de recebimento.

Retornos

ValueTask<ValueWebSocketReceiveResult>

O objeto de tarefa que representa a operação assíncrona. A propriedade Result no objeto da tarefa retorna um objeto ValueWebSocketReceiveResult que representa os dados recebidos.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.