< Summary

Information
Class: IceRpc.Extensions.DependencyInjection.ServerServiceCollectionExtensions
Assembly: IceRpc.Extensions.DependencyInjection
File(s): /home/runner/work/icerpc-csharp/icerpc-csharp/src/IceRpc.Extensions.DependencyInjection/ServerServiceCollectionExtensions.cs
Tag: 275_13775359185
Line coverage
86%
Covered lines: 39
Uncovered lines: 6
Coverable lines: 45
Total lines: 167
Line coverage: 86.6%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage
71%
Covered methods: 5
Total methods: 7
Method coverage: 71.4%

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
AddIceRpcServer(...)100%210%
AddIceRpcServer(...)100%11100%
AddIceRpcServer(...)100%11100%
AddIceRpcServer(...)100%210%
AddIceRpcServer(...)100%11100%
AddIceRpcServer(...)100%11100%
TryAddIceRpcServerTransport(...)100%11100%

File(s)

/home/runner/work/icerpc-csharp/icerpc-csharp/src/IceRpc.Extensions.DependencyInjection/ServerServiceCollectionExtensions.cs

#LineLine coverage
 1// Copyright (c) ZeroC, Inc.
 2
 3using IceRpc.Extensions.DependencyInjection.Internal;
 4using IceRpc.Transports;
 5using IceRpc.Transports.Slic;
 6using IceRpc.Transports.Tcp;
 7using Microsoft.Extensions.DependencyInjection;
 8using Microsoft.Extensions.DependencyInjection.Extensions;
 9using Microsoft.Extensions.Logging;
 10using Microsoft.Extensions.Options;
 11
 12namespace IceRpc.Extensions.DependencyInjection;
 13
 14/// <summary>Provides extension methods for <see cref="IServiceCollection" /> to add a <see cref="Server" />.</summary>
 15public static class ServerServiceCollectionExtensions
 16{
 17    /// <summary>Adds a <see cref="Server" /> with the specified dispatch pipeline to this service collection; you can
 18    /// specify the server's options by injecting an <see cref="IOptions{T}" /> of <see cref="ServerOptions" />.
 19    /// </summary>
 20    /// <param name="services">The service collection to add services to.</param>
 21    /// <param name="dispatcher">The dispatch pipeline.</param>
 22    /// <returns>The service collection.</returns>
 23    /// <example>
 24    /// The following code adds a Server singleton to the service collection.
 25    /// <code source="../../docfx/examples/IceRpc.Extensions.DependencyInjection.Examples/AddIceRpcServerExamples.cs"
 26    /// region="DefaultServer" lang="csharp" />
 27    /// The resulting singleton is a default server: it uses the default server address, the default multiplexed
 28    /// transport (tcp) and <c>null</c> for its authentication options (so no TLS). If you want to customize this
 29    /// server, add an <see cref="IOptions{T}" /> of <see cref="ServerOptions" /> to your DI container:
 30    /// <code source="../../docfx/examples/IceRpc.Extensions.DependencyInjection.Examples/AddIceRpcServerExamples.cs"
 31    /// region="ServerWithOptions" lang="csharp" />
 32    /// You can also inject a server transport:
 33    /// <list type="bullet">
 34    /// <item><description>an <see cref="IDuplexServerTransport" /> for the ice protocol</description></item>
 35    /// <item><description>an <see cref="IMultiplexedServerTransport" /> for the icerpc protocol</description></item>
 36    /// </list>
 37    ///
 38    /// For example, you can add a QUIC server as follows:
 39    /// <code source="../../docfx/examples/IceRpc.Extensions.DependencyInjection.Examples/AddIceRpcServerExamples.cs"
 40    /// region="ServerWithQuic" lang="csharp" />
 41    /// If you want to customize the options of the default transport (tcp), you just need to inject
 42    /// an <see cref="IOptions{T}" /> of <see cref="TcpServerTransportOptions" />.
 43    /// </example>
 44    public static IServiceCollection AddIceRpcServer(this IServiceCollection services, IDispatcher dispatcher) =>
 045        services.AddIceRpcServer(optionsName: Options.DefaultName, dispatcher);
 46
 47    /// <summary>Adds a <see cref="Server" /> to this service collection and configures the dispatch pipeline of this
 48    /// server; you can specify the server's options by injecting an <see cref="IOptions{T}" /> of
 49    /// <see cref="ServerOptions" />.
 50    /// </summary>
 51    /// <param name="services">The service collection to add services to.</param>
 52    /// <param name="configure">The action to configure the dispatch pipeline using an
 53    /// <see cref="IDispatcherBuilder" />.</param>
 54    /// <returns>The service collection.</returns>
 55    /// <remarks>The dispatch pipeline built by this method is not registered in the DI container.</remarks>
 56    /// <example>
 57    /// The following code builds a dispatch pipeline and adds a server with this dispatch pipeline to the service
 58    /// collection.
 59    /// <code source="../../docfx/examples/IceRpc.Extensions.DependencyInjection.Examples/AddIceRpcServerExamples.cs"
 60    /// region="ServerWithDispatcherBuilder"
 61    /// lang="csharp" />
 62    /// See also <see cref="AddIceRpcServer(IServiceCollection, IDispatcher)" />.
 63    /// </example>
 64    public static IServiceCollection AddIceRpcServer(
 65        this IServiceCollection services,
 66        Action<IDispatcherBuilder> configure) =>
 267        services.AddIceRpcServer(optionsName: Options.DefaultName, configure);
 68
 69    /// <summary>Adds a <see cref="Server" /> to this service collection; you specify the server's options by injecting
 70    /// an <see cref="IOptions{T}" /> of <see cref="ServerOptions" />.</summary>
 71    /// <param name="services">The service collection to add services to.</param>
 72    /// <returns>The service collection.</returns>
 73    /// <remarks>You need to set a least the dispatcher in the injected options.</remarks>
 74    public static IServiceCollection AddIceRpcServer(this IServiceCollection services) =>
 4075        services.AddIceRpcServer(Options.DefaultName);
 76
 77    /// <summary>Adds a <see cref="Server" /> with the specified dispatch pipeline to this service collection; you can
 78    /// specify the server's options by injecting an <see cref="IOptionsMonitor{T}" /> of <see cref="ServerOptions" />
 79    /// named <paramref name="optionsName" />.</summary>
 80    /// <param name="services">The service collection to add services to.</param>
 81    /// <param name="optionsName">The name of the options instance.</param>
 82    /// <param name="dispatcher">The dispatch pipeline of the server.</param>
 83    /// <returns>The service collection.</returns>
 84    /// <example>
 85    /// A server application may need to host multiple <see cref="Server" /> instances, each with its own options. A
 86    /// typical example is when you want to accept requests from clients over both the icerpc protocol and the ice
 87    /// protocol. This overload allows you to add two (or more) server singletons, each with its own options:
 88    /// <code source="../../docfx/examples/IceRpc.Extensions.DependencyInjection.Examples/AddIceRpcServerExamples.cs"
 89    /// region="ServerWithNamedOptions" lang="csharp" />
 90    /// See also <see cref="AddIceRpcServer(IServiceCollection, IDispatcher)" />.
 91    /// </example>
 92    public static IServiceCollection AddIceRpcServer(
 93        this IServiceCollection services,
 94        string optionsName,
 95        IDispatcher dispatcher)
 096    {
 097        services.AddOptions<ServerOptions>(optionsName).Configure(
 098            options => options.ConnectionOptions.Dispatcher = dispatcher);
 099        return services.AddIceRpcServer(optionsName);
 0100    }
 101
 102    /// <summary>Adds a <see cref="Server" /> to this service collection and configures the dispatch pipeline of this
 103    /// server; you can specify the server's options by injecting an <see cref="IOptionsMonitor{T}" /> of
 104    /// <see cref="ServerOptions" /> named <paramref name="optionsName" />.</summary>
 105    /// <param name="services">The service collection to add services to.</param>
 106    /// <param name="optionsName">The name of the options instance.</param>
 107    /// <param name="configure">The action to configure the dispatch pipeline using an
 108    /// <see cref="IDispatcherBuilder" />.</param>
 109    /// <returns>The service collection.</returns>
 110    /// <remarks>The dispatch pipeline built by this method is not registered in the DI container.</remarks>
 111    /// <seealso cref="AddIceRpcServer(IServiceCollection, string, IDispatcher)" />
 112    public static IServiceCollection AddIceRpcServer(
 113        this IServiceCollection services,
 114        string optionsName,
 115        Action<IDispatcherBuilder> configure) =>
 10116        services
 10117            .TryAddIceRpcServerTransport()
 10118            .AddSingleton(provider =>
 10119            {
 10120                var dispatcherBuilder = new DispatcherBuilder(provider);
 10121                configure(dispatcherBuilder);
 10122
 10123                ServerOptions options = provider.GetRequiredService<IOptionsMonitor<ServerOptions>>().Get(optionsName);
 10124                options.ConnectionOptions.Dispatcher = dispatcherBuilder.Build();
 10125
 10126                return new Server(
 10127                    options,
 10128                    provider.GetRequiredService<IDuplexServerTransport>(),
 10129                    provider.GetRequiredService<IMultiplexedServerTransport>(),
 10130                    provider.GetService<ILogger<Server>>());
 20131            });
 132
 133    /// <summary>Adds a <see cref="Server" /> to this service collection; you specify the server's options by injecting
 134    /// an <see cref="IOptionsMonitor{T}" /> of <see cref="ServerOptions" /> named <paramref name="optionsName" />.
 135    /// </summary>
 136    /// <param name="services">The service collection to add services to.</param>
 137    /// <param name="optionsName">The name of the options instance.</param>
 138    /// <returns>The service collection.</returns>
 139    /// <remarks>You need to set a least the dispatcher in the injected options.</remarks>
 140    /// <seealso cref="AddIceRpcServer(IServiceCollection, string, IDispatcher)" />
 141    public static IServiceCollection AddIceRpcServer(this IServiceCollection services, string optionsName) =>
 40142        services
 40143            .TryAddIceRpcServerTransport()
 40144            .AddSingleton(provider =>
 76145                new Server(
 76146                    provider.GetRequiredService<IOptionsMonitor<ServerOptions>>().Get(optionsName),
 76147                    provider.GetRequiredService<IDuplexServerTransport>(),
 76148                    provider.GetRequiredService<IMultiplexedServerTransport>(),
 76149                    provider.GetService<ILogger<Server>>()));
 150
 151    private static IServiceCollection TryAddIceRpcServerTransport(this IServiceCollection services)
 50152    {
 50153        services
 50154           .AddOptions()
 50155           .TryAddSingleton<IDuplexServerTransport>(
 50156               provider => new TcpServerTransport(
 50157                   provider.GetRequiredService<IOptions<TcpServerTransportOptions>>().Value));
 158
 50159        services
 50160            .TryAddSingleton<IMultiplexedServerTransport>(
 92161                provider => new SlicServerTransport(
 92162                    provider.GetRequiredService<IOptions<SlicTransportOptions>>().Value,
 92163                    provider.GetRequiredService<IDuplexServerTransport>()));
 164
 50165        return services;
 50166    }
 167}
Generated by: ReportGenerator 5.3.8.0
03/10/2025 - 21:46:44
GitHub | reportgenerator.io

Methods/Properties

AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,IceRpc.IDispatcher)
AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action`1<IceRpc.Extensions.DependencyInjection.IDispatcherBuilder>)
AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection)
AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,IceRpc.IDispatcher)
AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action`1<IceRpc.Extensions.DependencyInjection.IDispatcherBuilder>)
AddIceRpcServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)
TryAddIceRpcServerTransport(Microsoft.Extensions.DependencyInjection.IServiceCollection)