Skip to content

Replace draft WebSocket RFC with final RFC 6455 in API documentation #11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Replace draft WebSocket RFC with final RFC 6455 in API documentation #11982

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5c8c48
Initial plan
Copilot Oct 27, 2025
9286ebc
Replace draft RFC link with final RFC 6455 in WebSocket documentation
Copilot Oct 27, 2025
e3b27bc
Apply suggestions from code review
gewarren Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System.Net.WebSockets/WebSocket.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,15 @@ Exactly one send and one receive is supported on each <xref:System.Net.WebSocket
<param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
<param name="statusDescription">Specifies a human readable explanation as to why the connection is closed.</param>
<param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
<summary>Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the <see href="https://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06">WebSocket protocol specification</see> section 7.</summary>
<summary>Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the <see href="https://datatracker.ietf.org/doc/html/rfc6455">WebSocket protocol specification</see>, section 7.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This operation will not block. The returned <xref:System.Threading.Tasks.Task> object will complete after the WebSocket has been closed.

This method closes the WebSocket connection using the close handshake defined in the [WebSocket protocol specification](https://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06) section 7.
This method closes the WebSocket connection using the close handshake defined in the [WebSocket protocol specification](https://datatracker.ietf.org/doc/html/rfc6455), section 7.

]]></format>
</remarks>
Expand Down Expand Up @@ -251,7 +251,7 @@ Exactly one send and one receive is supported on each <xref:System.Net.WebSocket
<param name="closeStatus">Indicates the reason for closing the WebSocket connection.</param>
<param name="statusDescription">Allows applications to specify a human readable explanation as to why the connection is closed.</param>
<param name="cancellationToken">The token that can be used to propagate notification that operations should be canceled.</param>
<summary>Initiates or completes the close handshake defined in the <see href="https://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06">WebSocket protocol specification section 7</see>.</summary>
<summary>Initiates or completes the close handshake defined in the <see href="https://datatracker.ietf.org/doc/html/rfc6455">WebSocket protocol specification</see>, section 7.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down