ClientWebSocket.ReceiveAsync Método

Definição

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.Client.dll

Sobrecargas

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Recebe dados no ClientWebSocket como uma operação assíncrona.
ReceiveAsync(Memory<Byte>, CancellationToken)	Recebe dados no ClientWebSocket como uma operação assíncrona.

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Origem:

ClientWebSocket.cs

Recebe dados no ClientWebSocket como uma operação assíncrona.

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)

Parâmetros

buffer

ArraySegment<Byte>

O buffer que recebe a resposta.

cancellationToken

CancellationToken

Um token de cancelamento usado para propagar a notificação de que essa operação deve ser cancelada.

Retornos

Task<WebSocketReceiveResult>

O objeto de tarefa que representa a operação assíncrona.

Exceções

InvalidOperationException

O ClientWebSocket não está conectado.

ObjectDisposedException

O ClientWebSocket foi fechado.

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 após a conclusão da solicitação de recebimento na ClientWebSocket instância.

Há suporte para exatamente um envio e um recebimento em cada ClientWebSocket 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:

ClientWebSocket.cs

Recebe dados no ClientWebSocket como uma operação assíncrona.

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)

Parâmetros

buffer

Memory<Byte>

A região da memória a receber a resposta.

cancellationToken

CancellationToken

Um token de cancelamento usado para propagar a notificação de que essa operação deve ser cancelada.

Retornos

ValueTask<ValueWebSocketReceiveResult>

O objeto de tarefa que representa a operação assíncrona.

Exceções

InvalidOperationException

O ClientWebSocket não está conectado.

ObjectDisposedException

O ClientWebSocket foi fechado.

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 após a conclusão da solicitação de recebimento na ClientWebSocket instância.

Há suporte para exatamente um envio e um recebimento em cada ClientWebSocket 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.