WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) 方法

定义

命名空间:

System.Net.WebSockets

程序集:

System.Net.WebSockets.dll

Source:

WebSocket.cs

使用在 WebSocket 协议规范第 7 节中定义的关闭握手关闭作为异步操作的 WebSocket 连接。

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

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

abstract member CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

参数

closeStatus

WebSocketCloseStatus

指示关闭 WebSocket 连接的原因。

statusDescription

String

指定一个可读的解释为连接关闭的原因。

cancellationToken

CancellationToken

可用于传播有关应取消操作的通知的令牌。

返回

Task

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

例外

OperationCanceledException

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

注解

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

此方法使用 WebSocket 协议规范第 7 节中定义的关闭握手关闭 WebSocket 连接。