Microsoft.AspNetCore.SignalR Namespace

Reference

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides classes for SignalR applications, including configuring hub options and using hubs.

Classes

ClientProxyExtensions	Extension methods for IClientProxy.
DefaultHubLifetimeManager<THub>	A default in-memory lifetime manager abstraction for Hub instances.
DefaultUserIdProvider	The default provider for getting the user ID from a connection. This provider gets the user ID from the connection's User name identifier claim.
DynamicHub	A base class for SignalR hubs that use `dynamic` to represent client invocations.
DynamicHubClients	A class that provides `dynamic` access to connections, including the one that sent the current invocation.
GetHttpContextExtensions	Extension methods for accessing HttpContext from a hub context.
Hub	A base class for a SignalR hub.
Hub<T>	A base class for a strongly typed SignalR hub.
HubCallerContext	A context abstraction for accessing information about the hub caller connection.
HubClientsExtensions	Extension methods for IHubClients<T>.
HubConnectionContext	Encapsulates all information about an individual connection to a SignalR Hub.
HubConnectionContextOptions	Options used to configure HubConnectionContext.
HubConnectionHandler<THub>	Handles incoming connections and implements the SignalR Hub Protocol.
HubConnectionStore	Stores HubConnectionContexts by ID.
HubException	The exception thrown from a hub when an error occurs.
HubInvocationContext	Context for a Hub invocation.
HubLifetimeContext	Context for the hub lifetime events OnConnectedAsync() and OnDisconnectedAsync(Exception).
HubLifetimeManager<THub>	A lifetime manager abstraction for Hub instances.
HubMetadata	Metadata that describes the Hub information associated with a specific endpoint.
HubMethodNameAttribute	Customizes the name of a hub method.
HubOptions	Options used to configure hub instances.
HubOptions<THub>	Options used to configure the specified hub type instances. These options override globally set options.
HubOptionsExtensions	Methods to add IHubFilter's to Hubs.
HubOptionsSetup	Class to configure the HubOptions.
HubOptionsSetup<THub>	Class to configure the HubOptions for a specific `THub`.
HubRouteBuilder	Maps incoming requests to Hub types. This class is obsolete and will be removed in a future version. The recommended alternative is to use MapHub<THub> inside Microsoft.AspNetCore.Builder.UseEndpoints(...).
JsonHubProtocolOptions	Options used to configure a JsonHubProtocol instance.
MessagePackHubProtocolOptions	The MessagePackHubProtocol options.
NewtonsoftJsonHubProtocolOptions	Options used to configure a NewtonsoftJsonHubProtocol instance.
SerializedHubMessage	Represents a serialization cache for a single message.
SignalRConnectionBuilderExtensions	Extension methods for IConnectionBuilder.

Structs

HubConnectionStore.Enumerator	An IEnumerator over the HubConnectionStore
SerializedMessage	Represents a serialized message.

Interfaces

IClientProxy	A proxy abstraction for invoking hub methods.
IGroupManager	A manager abstraction for adding and removing connections from groups.
IHubActivator<THub>	A Hub activator abstraction.
IHubCallerClients	A clients caller abstraction for a hub.
IHubCallerClients<T>	An abstraction that provides access to client connections, including the one that sent the current invocation.
IHubClients	An abstraction that provides access to client connections.
IHubClients<T>	An abstraction that provides access to client connections.
IHubContext	A context abstraction for a hub.
IHubContext<THub>	A context abstraction for a hub.
IHubContext<THub,T>	A context abstraction for a hub.
IHubFilter	The filter abstraction for hub method invocations.
IHubProtocolResolver	A resolver abstraction for working with IHubProtocol instances.
IInvocationBinder	Class used by IHubProtocols to get the Type(s) expected by the hub message being deserialized.
ISignalRBuilder	A builder abstraction for configuring SignalR object instances.
ISignalRServerBuilder	A builder abstraction for configuring SignalR servers.
ISingleClientProxy	A proxy abstraction for invoking hub methods on the client and getting a result.
IUserIdProvider	A provider abstraction for configuring the "User ID" for a connection.

Remarks

For more information about SignalR, see Introduction to ASP.NET Core SignalR.