Talrace.Core.SignalR 8.0.0

About

This package for build real-time web applications using SignalR framework in .NET Core.
It provides sets of abstractions and implementations for working with SignalR in .NET Core:

• user/connection tracking for single application instance (using In-memory user store).
• user/connection tracking for multi application instance (using Redis user store).

Available api

SignalRServiceCollectionExtensions - static class provides extension methods for the IServiceCollection interface.
IUserTracker<out THub> - interface provides methods for managing user connections.
HubWithUserTracking - class provides connection, group, and messaging management. Define a user connection tracker.

SignalR configuration

Add SignalR with in the memory user connection tracking in dependency container.

public void ConfigureServices(IServiceCollection services) {
    services.AddInMemorySignalR();
}

Create a hub class inherited from HubWithUserTracking class and override GetUserTracker() method.

public class TestHub : HubWithUserTracking {
    public TestHub(IServiceProvider serviceProvider) : base(serviceProvider) { }

    protected override IUserTracker<HubWithUserTracking> GetUserTracker() {
        return ServiceProvider.GetRequiredService<IUserTracker<TestHub>>();
    }
}

Use MapHub<TestHub> to match the route for the Hub in the application.

public void Configure(IApplicationBuilder app) {
    app.UseEndpoints(endpoints => {
        endpoints.MapHub<TestHub>("/testhub");
    });
}

SignalR with redis server configuration

Add section about redis settings to appsettings.json.

{
  "RedisSettings": {
    "DefaultDatabase": <DatabaseIndex>,
    "EndPoints": [ "<ServerEndPoint>" ],
    "Password": "<ServerPassword>",
    "ChannelPrefix": "<ChannelPrefix>"
  }
}

Add SignalR with Redis user connection tracking in dependency container.

public void ConfigureServices(IServiceCollection services) {
    var section = Configuration.GetSection("RedisSettings");
    services.AddRedisSignalR(section);
}

Create a hub class inherited from HubWithUserTracking class and override GetUserTracker() method.

public class TestHub : HubWithUserTracking {
    public TestHub(IServiceProvider serviceProvider) : base(serviceProvider) { }

    protected override IUserTracker<HubWithUserTracking> GetUserTracker() {
        return ServiceProvider.GetRequiredService<IUserTracker<TestHub>>();
    }
}

Use MapHub<TestHub> to match the route for the Hub in the application.

public void Configure(IApplicationBuilder app) {
    app.UseEndpoints(endpoints => {
        endpoints.MapHub<TestHub>("/testhub");
    });
}