-
Notifications
You must be signed in to change notification settings - Fork 6k
Add WebSockets conceptual doc #32058
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.
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
Merged
IEvangelist
merged 8 commits into
dotnet:main
from
greenEkatherine:websocket-concept-doc
Nov 7, 2022
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
feb0bcb
Add WebSockets conceptual doc
9721a7a
Apply suggestions from code review
6e3e3c8
feedback
53f6fd1
Apply suggestions from code review
1ad54ae
Adding WebSockets doc into TOC
ecc8da0
Adding lifecycle example for WebSocket over HTTP/1.1
887c26e
Merge branch 'main' into websocket-concept-doc
e4f4632
Update docs/fundamentals/networking/websockets.md
IEvangelist File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: WebSockets support in .NET | ||
description: Learn how to web sockets with the ClientWebSockets in .NET. | ||
author: greenEkatherine | ||
ms.author: esokolov | ||
ms.date: 10/27/2022 | ||
--- | ||
|
||
# WebSockets support in .NET | ||
|
||
The WebSocket Protocol enables two-way communication between a client to a remote host that has opted-in to communications from that code. The <xref:System.Net.WebSockets.ClientWebSocket?displayProperty=fullName> exposes the ability to establish WebSocket connection via an opening handshake: it is created and sent by `ConnectAsync` method. | ||
|
||
## HTTP/2 vs HTTP/1.1 WebSockets | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
WebSockets over HTTP/1.1 uses a single TCP connection, therefore it is managed by connection-wide headers (see [RFC 6455](https://www.rfc-editor.org/rfc/rfc6455)). Here is an example of how to establish WebSocket over HTTP/1.1: | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```c# | ||
ClientWebSocket ws = new(); | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
ws.ConnectAsync(uri, cancellationToken); | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
A different approach must be taken with HTTP/2 due to its multiplexing nature: here, WebSockets are established per stream (see [RFC 8441](https://www.rfc-editor.org/rfc/rfc8441)). With HTTP/2 it is possible to use one connection for multiple web socket streams together with ordinary HTTP streams and extends HTTP/2's more efficient use of the network to WebSockets. There is a special overload of `ConnectAsync` which accepts `HttpMessageInvoker` to allow reusing existing pooled connections: | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```c# | ||
var handler = new SocketsHttpHandler(); | ||
ClientWebSocket ws = new(); | ||
ws.ConnectAsync(uri, new HttpMessageInvoker(handler), cancellationToken); | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
## How to set up HTTP version and policy | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
By default, `ClientWebSocket` uses HTTP/1.1 to send an opening handshake and allows downgrade. It can be changed before calling `ConnectAsync`: | ||
|
||
```c# | ||
ClientWebSocket ws = new(); | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
ws.Options.HttpVersion = HttpVersion.Version20; | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
ws.Options.HttpVersionPolicy = HttpVersionPolicy.RequestVersionOrHigher; | ||
|
||
ws.ConnectAsync(uri, new HttpMessageInvoker(handler), cancellationToken); | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
## Incompatible options | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
`ClientWebSocket` has properties <xref:System.Net.WebSockets.ClientWebSocketOptions?displayProperty=fullName> that the user can set up before the connection is established. However, when `HttpMessageInvoker` is provided, it also has these properties. To avoid ambiguity, in that case, properties should be set on `HttpMessageInvoker`, and `ClientWebSocketOptions` should have default values. Otherwise, if `ClientWebSocketOptions` are changed, overload of `ConnectAsync` will throw an <xref:System.ArgumentException>. | ||
|
||
## Compression | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
WebSocket supports per-message deflate as defined in [RFC 7692](https://tools.ietf.org/html/rfc7692#section-7). It is controlled by <xref:System.Net.WebSockets.ClientWebSocketOptions.DangerousDeflateOptions?displayProperty=fullName>. When present, the options are sent to the server during the handshake phase. If the server supports per-message-deflate and the options are accepted, the `WebSocket` instance will be created with compression enabled by default for all messages. | ||
IEvangelist marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
> [!IMPORTANT] | ||
> Before using it, please be aware that enabling compression makes the application subject to CRIME/BREACH type of attacks. It is strongly advised to turn off compression when sending data containing secrets by specifying `DisableCompression` flag for such messages. | ||
greenEkatherine marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.