csharp-signalr

What problem does it solve?

Prevents common SignalR Hub implementation mistakes and ensures reliable, secure, and scalable real-time messaging by prescribing correct Hub lifetime, state management, authorization, error handling, and scale-out patterns.

Core Features & Use Cases

• Hub lifetime & state guidance: Clarifies that Hub instances are transient and forbids storing per-connection state in instance fields, recommending external stores like Redis, databases, or IMemoryCache.
• Connection, group, and messaging patterns: Explains OnConnected/OnDisconnected hooks, meaningful group naming, and sending messages from outside hubs via IHubContext.
• Authentication, errors, and scale-out: Shows JWT-in-query handling for WebSockets, use of HubException for structured client errors, and options for scaling with Redis Backplane or Azure SignalR Service.
• Use case: Apply these rules when building chat systems, live notifications, or collaborative features to avoid lost state, insecure tokens, and cross-instance message loss.

Quick Start

Ask the AI to review or generate SignalR Hub code following csharp-signalr rules ensuring transient Hubs, no instance fields, external state storage, correct group management, JWT query handling for WebSockets, HubException usage for structured errors, and Redis or Azure backplane configuration for scale-out.