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

Definition

Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.

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

Parameters

closeStatus
WebSocketCloseStatus WebSocketCloseStatus WebSocketCloseStatus

Indicates the reason for closing the WebSocket connection.

statusDescription
String String String

Specifies a human readable explanation as to why the connection is closed.

cancellationToken
CancellationToken CancellationToken CancellationToken

The token that can be used to propagate notification that operations 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 WebSocket has been closed.

This method closes the WebSocket connection using the close handshake defined in the WebSocket protocol specification section 7.

Applies to