HubEndpointRouteBuilderExtensions.MapHub Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.SignalR.dll
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Overloads

MapHub<THub>(IEndpointRouteBuilder, String)

Maps incoming requests with the specified path to the specified Hub type.
MapHub<THub>(IEndpointRouteBuilder, String, Action<HttpConnectionDispatcherOptions>)

Maps incoming requests with the specified path to the specified Hub type.

MapHub<THub>(IEndpointRouteBuilder, String)

Source:
HubEndpointRouteBuilderExtensions.cs

Maps incoming requests with the specified path to the specified Hub type.

public:
generic <typename THub>
 where THub : Microsoft::AspNetCore::SignalR::Hub[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::HubEndpointConventionBuilder ^ MapHub(Microsoft::AspNetCore::Routing::IEndpointRouteBuilder ^ endpoints, System::String ^ pattern);
public static Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder MapHub<THub> (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern) where THub : Microsoft.AspNetCore.SignalR.Hub;
static member MapHub : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string -> Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder (requires 'Hub :> Microsoft.AspNetCore.SignalR.Hub)
<Extension()>
Public Function MapHub(Of THub As Hub) (endpoints As IEndpointRouteBuilder, pattern As String) As HubEndpointConventionBuilder

Type Parameters

THub

The Hub type to map requests to.

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder to add the route to.

pattern
String

The route pattern.

Returns

HubEndpointConventionBuilder

An HubEndpointConventionBuilder for endpoints associated with the connections.

Applies to

MapHub<THub>(IEndpointRouteBuilder, String, Action<HttpConnectionDispatcherOptions>)

Source:
HubEndpointRouteBuilderExtensions.cs

Maps incoming requests with the specified path to the specified Hub type.

public:
generic <typename THub>
 where THub : Microsoft::AspNetCore::SignalR::Hub[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::HubEndpointConventionBuilder ^ MapHub(Microsoft::AspNetCore::Routing::IEndpointRouteBuilder ^ endpoints, System::String ^ pattern, Action<Microsoft::AspNetCore::Http::Connections::HttpConnectionDispatcherOptions ^> ^ configureOptions);
public static Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder MapHub<THub> (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern, Action<Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions> configureOptions) where THub : Microsoft.AspNetCore.SignalR.Hub;
public static Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder MapHub<THub> (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern, Action<Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions>? configureOptions) where THub : Microsoft.AspNetCore.SignalR.Hub;
static member MapHub : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string * Action<Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions> -> Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder (requires 'Hub :> Microsoft.AspNetCore.SignalR.Hub)
<Extension()>
Public Function MapHub(Of THub As Hub) (endpoints As IEndpointRouteBuilder, pattern As String, configureOptions As Action(Of HttpConnectionDispatcherOptions)) As HubEndpointConventionBuilder

Type Parameters

THub

The Hub type to map requests to.

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder to add the route to.

pattern
String

The route pattern.

configureOptions
Action<HttpConnectionDispatcherOptions>

A callback to configure dispatcher options.

Returns

HubEndpointConventionBuilder

An HubEndpointConventionBuilder for endpoints associated with the connections.

Applies to