ClientWebSocket.ReceiveAsync 方法

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.Client.dll

重载

ReceiveAsync(ArraySegment<Byte>, CancellationToken)	将 ClientWebSocket 上的数据作为异步操作进行接收。
ReceiveAsync(Memory<Byte>, CancellationToken)	将 ClientWebSocket 上的数据作为异步操作进行接收。

ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Source:

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)

Source:

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 对象并行支持一个发送和一个接收。 不支持同时发出多个接收，这将导致未定义的行为。 应通过最适合你的任何机制（例如，使用锁或信号灯）来序列化接收操作。