ClientWebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) ClientWebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) ClientWebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Method

Definition

Close the ClientWebSocket instance as an asynchronous operation.

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

Parameters

closeStatus
WebSocketCloseStatus WebSocketCloseStatus WebSocketCloseStatus

The WebSocket close status.

statusDescription
String String String

A description of the close status.

cancellationToken
CancellationToken CancellationToken CancellationToken

A cancellation token used to propagate notification that this operation should be canceled.

Returns

The task object representing the asynchronous operation.

Remarks

This operation will not block. The returned Task object will complete after the ClientWebSocket instance is closed.

Applies to