SignalR Feature

The SignalR module enables seamless integration of SignalR within Orchard Core.

Creating a Hub

To create a SignalR hub in your module, first install the Microsoft.AspNetCore.SignalR.Core package using the NuGet Package Manager. Then, follow the official SignalR documentation to implement your hub.

To register the hub within your module, we recommend utilizing the HubRouteManager as shown below:

public sealed class ChatStartup : StartupBase
{
    public override void Configure(IApplicationBuilder app, IEndpointRouteBuilder routes, IServiceProvider serviceProvider)
    {
        var hubRouteManager = serviceProvider.GetRequiredService<HubRouteManager>();
        hubRouteManager.MapHub<AIChatHub>(routes);
    }
}

Configuring Hub options

You can configure options for a specific hub (for example to allow long-running operations or tune keep-alive settings) by configuring HubOptions<T> in ConfigureServices. For example:

services.Configure<HubOptions<AIChatHub>>(options =>
{
    options.ClientTimeoutInterval = TimeSpan.FromMinutes(10);
    options.KeepAliveInterval = TimeSpan.FromSeconds(15);
});

Adding Dependencies

In your module's Manifest file, declare a dependency on the CrestApps.OrchardCore.SignalR feature. Alternatively, you can use the SignalRConstants.Feature.Area constant to avoid hardcoded strings.

Generating the Hub URL

To obtain the SignalR hub URL dynamically within a client, inject HubRouteManager and generate the link as demonstrated below:

@inject HubRouteManager HubRouteManager

var url = HubRouteManager.GetUriByHub<AIChatHub>(ViewContext.HttpContext);

Then, initialize the SignalR connection using JavaScript:

<script type="text/javascript" at="Foot" depends-on="signalr">
    document.addEventListener("DOMContentLoaded", function () {
        var connection = new signalR.HubConnectionBuilder()
            .withUrl("@url")
            .build();

        connection.start()
            .then(function () {
                console.log('Connected to SignalR hub!');
            })
            .catch(function (error) {
                console.error('Connection failed:', error.message);
            });
    });
</script>

Note the dependency on the signalr script, which is automatically added to the page by the SignalR module.

This setup ensures your SignalR hub is properly registered and accessible within Orchard Core, allowing seamless real-time communication.