SignalR.Orleans 1.3.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package SignalR.Orleans --version 1.3.1
NuGet\Install-Package SignalR.Orleans -Version 1.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SignalR.Orleans" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SignalR.Orleans --version 1.3.1
#r "nuget: SignalR.Orleans, 1.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SignalR.Orleans as a Cake Addin
#addin nuget:?package=SignalR.Orleans&version=1.3.1

// Install SignalR.Orleans as a Cake Tool
#tool nuget:?package=SignalR.Orleans&version=1.3.1

Configuration

Silo

We need to configure the Orleans Silo with the below:

  • Use .UseSignalR() on ISiloHostBuilder.

Example

var silo = new SiloHostBuilder()
    .UseSignalR()
    .Build();

await silo.StartAsync();

Configure Silo Storage Provider and Grain Persistance

Optional configuration to override the default implementation for both providers which by default are set as Memory.

Example

.UseSignalR(cfg =>
{
    cfg.ConfigureBuilder = (builder, config) =>
    {
        builder
            .AddMemoryGrainStorage(config.PubSubProvider)
            .AddMemoryGrainStorage(config.StorageProvider);
    };
})

Client

Now your SignalR application needs to connect to the Orleans Cluster by using an Orleans Client:

  • Use .UseSignalR() on IClientBuilder.

Example

var client = new ClientBuilder()
    .UseSignalR()
    .Build();

await client.Connect();

Somewhere in your Startup.cs:

  • Use .AddSignalR() on IServiceCollection (this is part of Microsoft.AspNetCore.SignalR nuget package).
  • Use AddOrleans() on .AddSignalR().

Example

public void ConfigureServices(IServiceCollection services)
{
    ...
    services
        .AddSignalR()
        .AddOrleans();
    ...
}

Great! Now you have SignalR configured and Orleans SignalR backplane built in Orleans!

Features

Hub Context

HubContext gives you the ability to communicate with the client from orleans grains (outside the hub).

Sample usage: Receiving server push notifications from message brokers, web hooks, etc. Ideally first update your grain state and then push signalr message to the client.

Example

public class UserNotificationGrain : Grain<UserNotificationState>, IUserNotificationGrain
{
    private HubContext<IUserNotificationHub> _hubContext;

    public override async Task OnActivateAsync()
    {
        _hubContext = GrainFactory.GetHub<IUserNotificationHub>();
        // some code...
        await _hubContext.User(this.GetPrimaryKeyString()).Send("Broadcast", State.UserNotification);
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.2.0 2,402 8/28/2023
7.1.0 8,500 2/15/2023
7.0.1 764 2/14/2023
2.2.1 6,058 1/19/2023
2.2.0 10,589 8/8/2022
2.1.0 17,799 10/5/2021
2.0.1 6,426 2/15/2021
1.5.0 18,155 11/1/2019
1.4.4 8,280 11/1/2019
1.4.3 7,439 9/23/2019
1.4.2 2,822 9/8/2019
1.4.0 3,945 7/8/2019
1.3.2 3,568 6/13/2019
1.3.1 1,529 6/10/2019
1.2.0 2,960 3/21/2019
1.1.2 1,371 2/25/2019
1.1.1 1,807 1/24/2019
1.0.6 3,802 10/12/2018
1.0.5 2,049 7/24/2018
1.0.4 1,422 7/24/2018
1.0.3 1,436 7/4/2018
1.0.2 1,607 7/4/2018
1.0.1 1,630 6/23/2018
1.0.0-preview-65 1,652 5/31/2018
1.0.0-preview-63 1,483 5/8/2018
1.0.0-preview-60 1,400 4/25/2018
1.0.0-preview-58 1,324 4/24/2018
1.0.0-preview-52 1,489 3/28/2018
1.0.0-preview-50 1,635 3/28/2018
1.0.0-preview-47 1,444 3/16/2018
1.0.0-preview-44 1,412 3/13/2018
1.0.0-preview-42 1,396 3/5/2018
1.0.0-preview-39 1,416 3/5/2018
1.0.0-preview-37 1,370 3/2/2018
1.0.0-preview-32 1,831 12/21/2017
1.0.0-preview-26 1,329 12/12/2017
1.0.0-preview-22 1,300 11/24/2017
1.0.0-preview-19 1,263 11/22/2017