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

Definition

Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.

public:
 abstract System::Threading::Tasks::Task ^ CloseOutputAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);
public abstract System.Threading.Tasks.Task CloseOutputAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string statusDescription, System.Threading.CancellationToken cancellationToken);
abstract member CloseOutputAsync : 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

Allows applications to specify 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 output on the WebSocket has been closed.

Applies to