ClientWebSocket.ReceiveAsync 方法

定義

命名空間:

System.Net.WebSockets

組件:

System.Net.WebSockets.Client.dll

多載

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	將 ClientWebSocket 上的資料當成非同步作業接收。
ReceiveAsync(Memory<Byte>, CancellationToken)	將 ClientWebSocket 上的資料當成非同步作業接收。

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

來源:

ClientWebSocket.cs

將 ClientWebSocket 上的資料當成非同步作業接收。

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)

參數

buffer

ArraySegment<Byte>

接收回應的緩衝區。

cancellationToken

CancellationToken

這個取消語彙基元是用來傳播應該取消這項作業的通知。

傳回

Task<WebSocketReceiveResult>

工作物件，表示非同步作業。

例外狀況

InvalidOperationException

ClientWebSocket 未連接。

ObjectDisposedException

ClientWebSocket 已關閉。

OperationCanceledException

取消令牌已取消。 此例外狀況會儲存在傳回的工作中。

備註

這項作業不會封鎖。 傳回 Task<TResult> 的物件會在實例上的 ClientWebSocket 接收要求完成之後完成。

每個 ClientWebSocket 物件都支援一個傳送和一個接收。 不支援同時發出多個接收，而且會導致未定義的行為。 您應該使用鎖定或旗號，透過最適合您的任何機制來串行化接收作業。

ReceiveAsync(Memory<Byte>, CancellationToken)

來源:

ClientWebSocket.cs

將 ClientWebSocket 上的資料當成非同步作業接收。

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)

參數

buffer

Memory<Byte>

要接收回應的記憶體區域。

cancellationToken

CancellationToken

這個取消語彙基元是用來傳播應該取消這項作業的通知。

傳回

ValueTask<ValueWebSocketReceiveResult>

工作物件，表示非同步作業。

例外狀況

InvalidOperationException

ClientWebSocket 未連接。

ObjectDisposedException

ClientWebSocket 已關閉。

OperationCanceledException

取消令牌已取消。 此例外狀況會儲存在傳回的工作中。

備註

這項作業不會封鎖。 傳回 Task<TResult> 的物件會在實例上的 ClientWebSocket 接收要求完成之後完成。

每個 ClientWebSocket 物件都支援一個傳送和一個接收。 不支援同時發出多個接收，而且會導致未定義的行為。 您應該使用鎖定或旗號，透過最適合您的任何機制來串行化接收作業。