ClientWebSocket.ReceiveAsync Metoda

Definicja

Przestrzeń nazw:

System.Net.WebSockets

Zestaw:

System.Net.WebSockets.Client.dll

Przeciążenia

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	Odbiera dane jako ClientWebSocket operację asynchroniczną.
ReceiveAsync(Memory<Byte>, CancellationToken)	Odbiera dane jako ClientWebSocket operację asynchroniczną.

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Źródło:

ClientWebSocket.cs

Odbiera dane jako ClientWebSocket operację asynchroniczną.

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)

Parametry

buffer

ArraySegment<Byte>

Bufor do odbierania odpowiedzi.

cancellationToken

CancellationToken

Token odwołania, wykorzystywany do propagowania powiadomienia, że niniejsza operacja powinna zostać anulowana.

Zwraca

Task<WebSocketReceiveResult>

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

InvalidOperationException

Element ClientWebSocket nie jest połączony.

ObjectDisposedException

Została zamknięta ClientWebSocket .

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwróconym zadaniu.

Uwagi

Ta operacja nie będzie blokować. Zwrócony obiekt zostanie ukończony Task<TResult> po zakończeniu żądania odbioru w wystąpieniu ClientWebSocket .

Dokładnie jedno wysyłanie i jedna odbieranie jest obsługiwana równolegle dla każdego ClientWebSocket obiektu. Wystawianie wielu odbieranych w tym samym czasie nie jest obsługiwane i spowoduje niezdefiniowane zachowanie. Należy serializować operacje odbierania za pomocą dowolnego mechanizmu, który działa najlepiej, na przykład za pomocą blokady lub semafora.

ReceiveAsync(Memory<Byte>, CancellationToken)

Źródło:

ClientWebSocket.cs

Odbiera dane jako ClientWebSocket operację asynchroniczną.

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)

Parametry

buffer

Memory<Byte>

Region pamięci, w którym ma zostać odebrana odpowiedź.

cancellationToken

CancellationToken

Token odwołania, wykorzystywany do propagowania powiadomienia, że niniejsza operacja powinna zostać anulowana.

Zwraca

ValueTask<ValueWebSocketReceiveResult>

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

InvalidOperationException

Element ClientWebSocket nie jest połączony.

ObjectDisposedException

Została zamknięta ClientWebSocket .

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwróconym zadaniu.

Uwagi

Ta operacja nie będzie blokować. Zwrócony obiekt zostanie ukończony Task<TResult> po zakończeniu żądania odbioru w wystąpieniu ClientWebSocket .

Dokładnie jedno wysyłanie i jedna odbieranie jest obsługiwana równolegle dla każdego ClientWebSocket obiektu. Wystawianie wielu odbieranych w tym samym czasie nie jest obsługiwane i spowoduje niezdefiniowane zachowanie. Należy serializować operacje odbierania za pomocą dowolnego mechanizmu, który działa najlepiej, na przykład za pomocą blokady lub semafora.