Vorn.EntityManagement.SignalR.Client 4.6.0

Vorn.EntityManagement.SignalR.Client

Philosophy

The client package complements the SignalR server hub and provides a strongly typed abstraction over SignalR connections. Instead of sprinkling HubConnection calls across your UI, you inherit from EntityClient<TDto, TDescriptorDto> to get a resilient proxy that mirrors the CRUD surface of the server. The design promotes:

• Connection orchestration – The base class lazily creates and starts a SignalR connection via an IEntityConnectionFactory, only when first needed.
• Command parity – Each CRUD/query call on the client invokes the matching hub method, guaranteeing that client and server contracts evolve together.
• Notification awareness – Built-in subscription support surfaces EntityNotificationDto events through the EntityNotificationReceived delegate for real-time UI updates.

Getting started

1. Install the package

Install-Package Vorn.EntityManagement.SignalR.Client

2. Implement a connection factory

public sealed class DocumentConnectionFactory : IEntityConnectionFactory
{
    public async Task<HubConnection> CreateConnection<TDto>()
    {
        var connection = new HubConnectionBuilder()
            .WithUrl("https://api.contoso.com/hubs/documents")
            .WithAutomaticReconnect()
            .Build();

        await connection.StartAsync();
        return connection;
    }
}

Register the factory with your dependency injection container so the client can obtain a configured HubConnection.

3. Derive a typed client

public sealed class DocumentClient(IEntityConnectionFactory factory)
    : EntityClient<DocumentDto, DocumentDescriptorDto>(factory)
{ }

The base class guarantees connection startup and event wiring through EnsureConnectionAsync, StartAsync, and RegisterEvents.

4. Consume the client

await using var client = serviceProvider.GetRequiredService<DocumentClient>();
await client.SetInterceptionConfig(userId: "42", time: DateTimeOffset.UtcNow);

var created = await client.AddAsync(new DocumentDto { Title = "Roadmap" });
var paged = await client.GetPagedAsDtoAsync(new DocumentDescriptorDto { TenantId = "tenant-a" });

If the server emits notifications, subscribe to the EntityNotificationReceived event to update your UI.

client.EntityNotificationReceived += (_, notification) =>
{
    // Refresh the relevant view
};

5. Dispose gracefully

EntityClient implements IAsyncDisposable to stop and dispose of the underlying connection when you're done, even if disposal happens during shutdown.

Usage tips

• Call SetInterceptionConfig to forward user/time metadata to the server so audit context is maintained for each invocation.
• Override RegisterEvents or EntityNotification in a derived class if you need custom notification handling (e.g., mapping to view models) before raising the event.
• Combine the client with typed DTOs produced by Vorn.EntityManagement.Generators for a zero-boilerplate experience across REST and SignalR transports.

Release artifacts

The README is packaged with the NuGet distribution, making the setup guidance available inside Visual Studio, NuGet.org, and dotnet package tooling.