CloseOutputAsync Method

WebSocket.CloseOutputAsync Method (WebSocketCloseStatus, String, CancellationToken)

.NET Framework (current version)
 

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

Namespace:   System.Net.WebSockets
Assembly:  System (in System.dll)

public abstract Task CloseOutputAsync(
	WebSocketCloseStatus closeStatus,
	string statusDescription,
	CancellationToken cancellationToken
)

Parameters

closeStatus
Type: System.Net.WebSockets.WebSocketCloseStatus

Indicates the reason for closing the WebSocket connection.

statusDescription
Type: System.String

Allows applications to specify a human readable explanation as to why the connection is closed.

cancellationToken
Type: System.Threading.CancellationToken

The token that can be used to propagate notification that operations should be canceled.

Return Value

Type: System.Threading.Tasks.Task

Returns Task.

The task object representing the asynchronous operation.

This operation will not block. The returned Task object will complete after the output on the WebSocket has been closed.

.NET Framework
Available since 4.5
Return to top
Show:
© 2016 Microsoft