Skip to content

Commit 1c8fc3d

Browse files
authored
SignalR Client Features doc -> SignalR Clients overview doc (#18293)
1 parent c1030c4 commit 1c8fc3d

2 files changed

Lines changed: 33 additions & 17 deletions

File tree

aspnetcore/signalr/client-features.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: SignalR client features
2+
title: ASP.NET Core SignalR clients
33
author: bradygaster
44
description: Learn which features are supported by the various ASP.NET Core SignalR clients.
55
ms.author: bradyg
@@ -8,25 +8,41 @@ ms.date: 11/12/2019
88
no-loc: [Blazor, "Identity", "Let's Encrypt", Razor, SignalR]
99
uid: signalr/client-features
1010
---
11-
# ASP.NET Core SignalR client features
11+
# ASP.NET Core SignalR clients
12+
13+
## Versioning, support, and compatibility
14+
15+
The SignalR clients ship alongside the server components and are versioned to match. Any supported client can safely connect to any supported server, and any compatibility issues would be considered bugs to be fixed. SignalR clients are supported in the same support lifecycle as the rest of .NET Core. See [the .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core) for details.
16+
17+
Many features require a compatible client **and** server. See below for a table showing the minimum versions for various features.
18+
19+
The 1.x versions of SignalR map to the 2.1 and 2.2 .NET Core releases and have the same lifetime. For version 3.x and above, the SignalR version exactly matches the rest of .NET and has the same support lifecycle.
20+
21+
| SignalR version | .NET Core version | Support level | End of support |
22+
| - | - | - | - |
23+
| 1.0.x | 2.1.x | Long Term Support | August 21, 2021 |
24+
| 1.1.x | 2.2.x | End Of Life | December 23, 2019 |
25+
| 3.x or higher | *same as SignalR version* | See the [the .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core) |
26+
27+
**NOTE:** In ASP.NET Core 3.0, the JavaScript client *moved* to the `@microsoft/signalr` npm package.
1228

1329
## Feature distribution
1430

1531
The table below shows the features and support for the clients that offer real-time support. For each feature, the *minimum* version supporting this feature is listed. If no version is listed, the feature isn't supported.
1632

17-
| Feature | .NET | JavaScript | Java |
18-
| ---- | :-: | :-: | :-: |
19-
| Azure SignalR Service Support |1.0.0|1.0.0|1.0.0|
20-
| [Server-to-client Streaming](xref:signalr/streaming) |1.0.0|1.0.0|1.0.0|
21-
| [Client-to-server Streaming](xref:signalr/streaming) |3.0.0|3.0.0|3.0.0|
22-
| Automatic Reconnection ([.NET](/aspnet/core/signalr/dotnet-client?view=aspnetcore-3.0&tabs=visual-studio#handle-lost-connection), [JavaScript](/aspnet/core/signalr/javascript-client?view=aspnetcore-3.0#reconnect-clients)) |3.0.0|3.0.0||
23-
| WebSockets Transport |1.0.0|1.0.0|1.0.0|
24-
| Server-Sent Events Transport |1.0.0|1.0.0||
25-
| Long Polling Transport |1.0.0|1.0.0|3.0.0|
26-
| JSON Hub Protocol |1.0.0|1.0.0|1.0.0|
27-
| MessagePack Hub Protocol |1.0.0|1.0.0||
28-
29-
Support for automatic reconnect in the Java client is tracked in [our issue tracker](https://github.com/dotnet/AspNetCore/issues/8711).
33+
| Feature | Server | .NET client | JavaScript client | Java client |
34+
| ---- | :-: | :-: | :-: | :-: |
35+
| Azure SignalR Service Support |2.1.0|1.0.0|1.0.0|1.0.0|
36+
| [Server-to-client Streaming](xref:signalr/streaming) |2.1.0|1.0.0|1.0.0|1.0.0|
37+
| [Client-to-server Streaming](xref:signalr/streaming) |3.0.0|3.0.0|3.0.0|3.0.0|
38+
| Automatic Reconnection ([.NET](/aspnet/core/signalr/dotnet-client?view=aspnetcore-3.0&tabs=visual-studio#handle-lost-connection), [JavaScript](/aspnet/core/signalr/javascript-client?view=aspnetcore-3.0#reconnect-clients)) |3.0.0|3.0.0|3.0.0||
39+
| WebSockets Transport |2.1.0|1.0.0|1.0.0|1.0.0|
40+
| Server-Sent Events Transport |2.1.0|1.0.0|1.0.0||
41+
| Long Polling Transport |2.1.0|1.0.0|1.0.0|3.0.0|
42+
| JSON Hub Protocol |2.1.0|1.0.0|1.0.0|1.0.0|
43+
| MessagePack Hub Protocol |2.1.0|1.0.0|1.0.0||
44+
45+
Support for enabling additional client features is tracked in [our issue tracker](https://github.com/dotnet/AspNetCore/issues).
3046

3147
## Additional resources
3248

aspnetcore/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@
557557
- name: Clients
558558
displayName: signalr
559559
items:
560-
- name: SignalR client features
560+
- name: Overview
561561
uid: signalr/client-features
562562
displayName: signalr
563563
- name: .NET client
@@ -1286,4 +1286,4 @@
12861286
- name: API reference
12871287
href: /dotnet/api/?view=aspnetcore-2.2
12881288
- name: Contribute
1289-
href: https://github.com/dotnet/AspNetCore.Docs/blob/master/CONTRIBUTING.md
1289+
href: https://github.com/dotnet/AspNetCore.Docs/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)