ClientWebSocket.CloseAsync 方法

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.Client.dll

Source:

ClientWebSocket.cs

关闭作为异步操作的 ClientWebSocket 实例。

public:
 override System::Threading::Tasks::Task ^ CloseAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task CloseAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string? statusDescription, System.Threading.CancellationToken cancellationToken);

override this.CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function CloseAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

参数

closeStatus

WebSocketCloseStatus

WebSocket 关闭状态。

statusDescription

String

关闭状态的说明。

cancellationToken

CancellationToken

可用于传播应取消此操作的通知的取消标记。

返回

Task

表示异步操作的任务对象。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此操作不会阻止。 返回的对象 Task 将在实例关闭后 ClientWebSocket 完成。