6.9 KiB
| title | author | description | monikerRange | ms.author | ms.date | uid |
|---|---|---|---|---|---|---|
| Differences between SignalR and ASP.NET Core SignalR | tdykstra | Differences between SignalR and ASP.NET Core SignalR | >= aspnetcore-2.1 | tdykstra | 09/10/2018 | signalr/version-differences |
Differences between ASP.NET SignalR and ASP.NET Core SignalR
ASP.NET Core SignalR isn't compatible with clients or servers for ASP.NET SignalR. This article details features which have been removed or changed in ASP.NET Core SignalR.
How to identify the SignalR version
| ASP.NET SignalR | ASP.NET Core SignalR | |
|---|---|---|
| Server NuGet Package | Microsoft.AspNet.SignalR | Microsoft.AspNetCore.App (.NET Core) Microsoft.AspNetCore.SignalR (.NET Framework) |
| Client NuGet Packages | Microsoft.AspNet.SignalR.Client Microsoft.AspNet.SignalR.JS |
Microsoft.AspNetCore.SignalR.Client |
| Client npm Package | signalr | @aspnet/signalr |
| Server App Type | ASP.NET (System.Web) or OWIN Self-Host | ASP.NET Core |
| Supported Server Platforms | .NET Framework 4.5 or later | .NET Framework 4.6.1 or later .NET Core 2.1 or later |
Feature differences
Automatic reconnects
Automatic reconnects are no longer supported. Previously, SignalR tried to reconnect to the server if the connection was dropped. Now, if the client is disconnected the user must explicitly start a new connection if they want to reconnect.
Protocol support
ASP.NET Core SignalR supports JSON, as well as a new binary protocol based on MessagePack. Additionally, custom protocols can be created.
Differences on the server
The ASP.NET Core SignalR server-side libraries are included in the Microsoft.AspNetCore.App metapackage package that's part of the ASP.NET Core Web Application template for both Razor and MVC projects.
ASP.NET Core SignalR is an ASP.NET Core middleware, so it must be configured by calling AddSignalR in Startup.ConfigureServices.
services.AddSignalR()
To configure routing, map routes to hubs inside the UseSignalR method call in the Startup.Configure method.
app.UseSignalR(routes =>
{
routes.MapHub<ChatHub>("/hub");
});
Sticky sessions now required
Because of how scale-out worked in ASP.NET SignalR, clients could reconnect and send messages to any server in the farm. Due to changes to the scale-out model, as well as not supporting reconnects, this is no longer supported. Once the client connects to the server, it must interact with the same server for the duration of the connection.
Single hub per connection
In ASP.NET Core SignalR, the connection model has been simplified. Connections are made directly to a single hub, rather than a single connection being used to share access to multiple hubs.
Streaming
ASP.NET Core SignalR now supports streaming data from the hub to the client.
State
The ability to pass arbitrary state between clients and the hub (often called HubState) has been removed, as well as support for progress messages. There is no counterpart of hub proxies at the moment.
Differences on the client
TypeScript
The ASP.NET Core SignalR client is written in TypeScript. You can write in JavaScript or TypeScript when using the JavaScript client.
The JavaScript client is hosted at npm
In previous versions, the JavaScript client was obtained through a NuGet package in Visual Studio. For the Core versions, the @aspnet/signalr npm package contains the JavaScript libraries. This package isn't included in the ASP.NET Core Web Application template. Use npm to obtain and install the @aspnet/signalr npm package.
npm init -y
npm install @aspnet/signalr
jQuery
The dependency on jQuery has been removed, however projects can still use jQuery.
JavaScript client method syntax
The JavaScript syntax has changed from the previous version of SignalR. Rather than using the $connection object, create a connection using the HubConnectionBuilder API.
const connection = new signalR.HubConnectionBuilder()
.withUrl("/hub")
.build();
Use the on method to specify client methods that the hub can call.
connection.on("ReceiveMessage", (user, message) => {
const msg = message.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
const encodedMsg = user + " says " + msg;
log(encodedMsg);
});
After creating the client method, start the hub connection. Chain a catch method to log or handle errors.
connection.start().catch(err => console.error(err.toString()));
Hub proxies
Hub proxies are no longer automatically generated. Instead, the method name is passed into the invoke API as a string.
.NET and other clients
The Microsoft.AspNetCore.SignalR.Client NuGet package contains the .NET client libraries for ASP.NET Core SignalR.
Use the HubConnectionBuilder to create and build an instance of a connection to a hub.
connection = new HubConnectionBuilder()
.WithUrl("url")
.Build();
Scaleout differences
ASP.NET SignalR supports both SQL Server and Redis. ASP.NET Core SignalR supports both Azure SignalR Service and Redis.
ASP.NET
- SignalR scaleout with Azure Service Bus
- SignalR scaleout with Redis
- SignalR scaleout with SQL Server