ClientWebSocket.CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) Method

Definition

Close the output for the ClientWebSocket instance as an asynchronous operation.

public:
 override System::Threading::Tasks::Task ^ CloseOutputAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task CloseOutputAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string? statusDescription, System.Threading.CancellationToken cancellationToken);
public override System.Threading.Tasks.Task CloseOutputAsync (System.Net.WebSockets.WebSocketCloseStatus closeStatus, string statusDescription, System.Threading.CancellationToken cancellationToken);
override this.CloseOutputAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function CloseOutputAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

Parameters

closeStatus
WebSocketCloseStatus

The WebSocket close status.

statusDescription
String

A description of the close status.

cancellationToken
CancellationToken

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

Returns

Task

The task object representing the asynchronous operation.

Remarks

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

Applies to