Failed Connections

[londospark]

What do we expect on a failed connection? Would it be a cancelled Task or a faulted Task?

---

Document details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 024a4c4b-33f9-bd6f-a3d2-0815977d59f0
• Version Independent ID: aaa1d5a4-b22a-4dda-4715-fa5bb4d614bf
• Content: ClientWebSocket.ConnectAsync(Uri, CancellationToken) Method (System.Net.WebSockets)
• Content Source: xml/System.Net.WebSockets/ClientWebSocket.xml
• Product: dotnet-api
• GitHub Login: @karelz
• Microsoft Alias: ncldev

[karelz]

Failed connection will throw exception. If the source was cancellation, then it will be TaskCancelledException, otherwise different exception.
Does it help?

[cosminstirbu]

It doesn't help that much, we would need to know what are the exceptions thrown in case of connection error, etc.

[cspaniard]

Wow...
This is not even close to being acceptable. How are we supposed to code if it is not documented what exceptions could be thrown ?

@karelz I really appreciate you answering, but nowhere in the documents or your comments tells us what is the failed connection exception thrown or any other error.

In the old MS Docs, the possible exceptions thrown by any object method were documented.

I will look in the old docs if I can find info on ClientWebSocket ;)

[mairaw]

The content from the old MS docs were mostly all ported here @cspaniard - we're working on the last few migration issues. We don't usually document common exceptions that are caused by external factors instead of directly caused by the use of the API if that makes sense, such as network errors, IO errors, etc.

So for this API, we should document at least the following exceptions based on what I see here:
https://referencesource.microsoft.com/#System/net/System/Net/WebSockets/ClientWebSocket.cs,9503b6a5d6701068

• ArgumentNullException
• ArgumentException
• ObjectDisposedException
• InvalidOperationException
• WebException
• Exception

I'll schedule to do this on a future sprint

[cspaniard]

Thanks @mairaw... I appreciate you looking into this issue.

These are the exceptions I get just by specifying a bad port:

System.Net.WebSockets.WebSocketException: Unable to connect to the remote server
System.Net.Http.HttpRequestException: Connection refused.
System.Net.Sockets.SocketException: Connection refused.

Taking into account what you mentioned, I don't know how to solve this, but IMHO I think that at least System.Net.WebSockets.WebSocketException should be in the docs (besides the one you pointed out)

Again, thanks for looking into it...

David