Skip to content

Commit 3e906fb

Browse files
authored
Minor API cleanup (#2147)
1 parent 555c1fd commit 3e906fb

File tree

6 files changed

+25
-30
lines changed

6 files changed

+25
-30
lines changed

src/Microsoft.AspNetCore.Http.Connections/ConnectionsRouteBuilder.cs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,7 @@ public class ConnectionsRouteBuilder
1818
private readonly HttpConnectionDispatcher _dispatcher;
1919
private readonly RouteBuilder _routes;
2020

21-
/// <summary>
22-
/// Initializes a new instance of the <see cref="ConnectionsRouteBuilder"/> class.
23-
/// </summary>
24-
/// <param name="routes">The underlying <see cref="RouteBuilder"/>.</param>
25-
/// <param name="dispatcher">The dispatcher.</param>
26-
public ConnectionsRouteBuilder(RouteBuilder routes, HttpConnectionDispatcher dispatcher)
21+
internal ConnectionsRouteBuilder(RouteBuilder routes, HttpConnectionDispatcher dispatcher)
2722
{
2823
_routes = routes;
2924
_dispatcher = dispatcher;

src/Microsoft.AspNetCore.Http.Connections/Internal/TimerAwaitable.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace Microsoft.AspNetCore.Http.Connections.Internal
1010
{
11-
public class TimerAwaitable : IDisposable, ICriticalNotifyCompletion
11+
internal class TimerAwaitable : IDisposable, ICriticalNotifyCompletion
1212
{
1313
private Timer _timer;
1414
private Action _callback;

src/Microsoft.AspNetCore.SignalR.Core/DynamicHubClients.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ public DynamicHubClients(IHubCallerClients clients)
9797
/// <summary>
9898
/// Gets an object that can be used to invoke methods on all connections associated with all of the specified users.
9999
/// </summary>
100-
/// <param name="users">The user IDs.</param>
100+
/// <param name="userIds">The user IDs.</param>
101101
/// <returns>An object that can be used to invoke methods.</returns>
102-
public dynamic Users(IReadOnlyList<string> users) => new DynamicClientProxy(_clients.Users(users));
102+
public dynamic Users(IReadOnlyList<string> userIds) => new DynamicClientProxy(_clients.Users(userIds));
103103
}
104104
}

src/Microsoft.AspNetCore.SignalR.Core/IHubClientsExtensions.cs renamed to src/Microsoft.AspNetCore.SignalR.Core/HubClientsExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.SignalR
88
/// <summary>
99
/// Extension methods for <see cref="IHubClients{T}"/>.
1010
/// </summary>
11-
public static class IHubClientsExtensions
11+
public static class HubClientsExtensions
1212
{
1313
/// <summary>
1414
/// Gets a <typeparamref name="T" /> that can be used to invoke methods on all clients connected to the hub excluding the specified connection.

src/Microsoft.AspNetCore.SignalR.Redis/RedisDependencyInjectionExtensions.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ public static class RedisDependencyInjectionExtensions
1616
/// <summary>
1717
/// Adds scale-out to a <see cref="ISignalRServerBuilder"/>, using a shared Redis server.
1818
/// </summary>
19-
/// <param name="builder">The <see cref="ISignalRServerBuilder"/>.</param>
19+
/// <param name="signalrBuilder">The <see cref="ISignalRServerBuilder"/>.</param>
2020
/// <returns>The same instance of the <see cref="ISignalRServerBuilder"/> for chaining.</returns>
21-
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder builder)
21+
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder signalrBuilder)
2222
{
23-
return AddRedis(builder, o => { });
23+
return AddRedis(signalrBuilder, o => { });
2424
}
2525

2626
/// <summary>
2727
/// Adds scale-out to a <see cref="ISignalRServerBuilder"/>, using a shared Redis server.
2828
/// </summary>
29-
/// <param name="builder">The <see cref="ISignalRServerBuilder"/>.</param>
29+
/// <param name="signalrBuilder">The <see cref="ISignalRServerBuilder"/>.</param>
3030
/// <param name="redisConnectionString">The connection string used to connect to the Redis server.</param>
3131
/// <returns>The same instance of the <see cref="ISignalRServerBuilder"/> for chaining.</returns>
32-
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder builder, string redisConnectionString)
32+
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder signalrBuilder, string redisConnectionString)
3333
{
34-
return AddRedis(builder, o =>
34+
return AddRedis(signalrBuilder, o =>
3535
{
3636
o.Configuration = ConfigurationOptions.Parse(redisConnectionString);
3737
});
@@ -40,26 +40,26 @@ public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder builder,
4040
/// <summary>
4141
/// Adds scale-out to a <see cref="ISignalRServerBuilder"/>, using a shared Redis server.
4242
/// </summary>
43-
/// <param name="builder">The <see cref="ISignalRServerBuilder"/>.</param>
43+
/// <param name="signalrBuilder">The <see cref="ISignalRServerBuilder"/>.</param>
4444
/// <param name="configure">A callback to configure the Redis options.</param>
4545
/// <returns>The same instance of the <see cref="ISignalRServerBuilder"/> for chaining.</returns>
46-
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder builder, Action<RedisOptions> configure)
46+
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder signalrBuilder, Action<RedisOptions> configure)
4747
{
48-
builder.Services.Configure(configure);
49-
builder.Services.AddSingleton(typeof(HubLifetimeManager<>), typeof(RedisHubLifetimeManager<>));
50-
return builder;
48+
signalrBuilder.Services.Configure(configure);
49+
signalrBuilder.Services.AddSingleton(typeof(HubLifetimeManager<>), typeof(RedisHubLifetimeManager<>));
50+
return signalrBuilder;
5151
}
5252

5353
/// <summary>
5454
/// Adds scale-out to a <see cref="ISignalRServerBuilder"/>, using a shared Redis server.
5555
/// </summary>
56-
/// <param name="builder">The <see cref="ISignalRServerBuilder"/>.</param>
56+
/// <param name="signalrBuilder">The <see cref="ISignalRServerBuilder"/>.</param>
5757
/// <param name="redisConnectionString">The connection string used to connect to the Redis server.</param>
5858
/// <param name="configure">A callback to configure the Redis options.</param>
5959
/// <returns>The same instance of the <see cref="ISignalRServerBuilder"/> for chaining.</returns>
60-
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder builder, string redisConnectionString, Action<RedisOptions> configure)
60+
public static ISignalRServerBuilder AddRedis(this ISignalRServerBuilder signalrBuilder, string redisConnectionString, Action<RedisOptions> configure)
6161
{
62-
return AddRedis(builder, o =>
62+
return AddRedis(signalrBuilder, o =>
6363
{
6464
o.Configuration = ConfigurationOptions.Parse(redisConnectionString);
6565
configure(o);

src/Microsoft.AspNetCore.SignalR/SignalRDependencyInjectionExtensions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ public static class SignalRDependencyInjectionExtensions
1818
/// </summary>
1919
/// <typeparam name="THub">The hub type to configure.</typeparam>
2020
/// <param name="signalrBuilder">The <see cref="ISignalRServerBuilder"/>.</param>
21-
/// <param name="options">A callback to configure the hub options.</param>
21+
/// <param name="configure">A callback to configure the hub options.</param>
2222
/// <returns>The same instance of the <see cref="ISignalRServerBuilder"/> for chaining.</returns>
23-
public static ISignalRServerBuilder AddHubOptions<THub>(this ISignalRServerBuilder signalrBuilder, Action<HubOptions<THub>> options) where THub : Hub
23+
public static ISignalRServerBuilder AddHubOptions<THub>(this ISignalRServerBuilder signalrBuilder, Action<HubOptions<THub>> configure) where THub : Hub
2424
{
2525
signalrBuilder.Services.AddSingleton<IConfigureOptions<HubOptions<THub>>, HubOptionsSetup<THub>>();
26-
signalrBuilder.Services.Configure(options);
26+
signalrBuilder.Services.Configure(configure);
2727
return signalrBuilder;
2828
}
2929

@@ -44,11 +44,11 @@ public static ISignalRServerBuilder AddSignalR(this IServiceCollection services)
4444
/// Adds SignalR services to the specified <see cref="IServiceCollection" />.
4545
/// </summary>
4646
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
47-
/// <param name="options">An <see cref="Action{MvcOptions}"/> to configure the provided <see cref="HubOptions"/>.</param>
47+
/// <param name="configure">An <see cref="Action{MvcOptions}"/> to configure the provided <see cref="HubOptions"/>.</param>
4848
/// <returns>An <see cref="ISignalRServerBuilder"/> that can be used to further configure the SignalR services.</returns>
49-
public static ISignalRServerBuilder AddSignalR(this IServiceCollection services, Action<HubOptions> options)
49+
public static ISignalRServerBuilder AddSignalR(this IServiceCollection services, Action<HubOptions> configure)
5050
{
51-
return services.Configure(options)
51+
return services.Configure(configure)
5252
.AddSignalR();
5353
}
5454
}

0 commit comments

Comments
 (0)