ClientWebSocket.ConnectAsync Method (Uri, CancellationToken)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Connect to a WebSocket server as an asynchronous operation.

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

public Task ConnectAsync(
	Uri uri,
	CancellationToken cancellationToken
)

Parameters

uri
Type: System.Uri

The URI of the WebSocket server to connect to.

cancellationToken
Type: System.Threading.CancellationToken

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

Return Value

Type: System.Threading.Tasks.Task

Returns Task.

The task object representing the asynchronous operation.

The ConnectAsync method initiates the WebSocket handshake with a remote network destination, and then negotiates the sub-protocol.

For plain WebSocket connections, use the ws:// scheme in the uri. For secure WebSocket connections over TLS/SSL, use the wss:// scheme.

This operation will not block. The returned Task object will complete after the connect request on the ClientWebSocket instance has completed.

.NET Framework
Available since 4.5
Return to top
Show: