Class SignalServiceCollectionExtensions
- Namespace
- Signal.Hosting
- Assembly
- Signal.Hosting.dll
Entry points for adding Signal.NET to a .NET Generic Host.
public static class SignalServiceCollectionExtensions
- Inheritance
-
SignalServiceCollectionExtensions
- Inherited Members
Methods
AddSignal(IServiceCollection, IConfiguration)
Adds Signal.NET, binding SignalOptions from configuration.
public static ISignalBuilder AddSignal(this IServiceCollection services, IConfiguration configuration)
Parameters
servicesIServiceCollectionThe service collection.
configurationIConfigurationThe configuration section containing the Signal settings.
Returns
- ISignalBuilder
A builder to register commands, handlers and extensions.
AddSignal(IServiceCollection, Action<SignalOptions>)
Adds Signal.NET, configuring SignalOptions in code.
public static ISignalBuilder AddSignal(this IServiceCollection services, Action<SignalOptions> configure)
Parameters
servicesIServiceCollectionThe service collection.
configureAction<SignalOptions>Configures the options.
Returns
- ISignalBuilder
A builder to register commands, handlers and extensions.
AddSignal(IHostApplicationBuilder)
Adds Signal.NET, binding SignalOptions from the Signal configuration section.
Registers the application and infrastructure layers and the background receiver.
public static ISignalBuilder AddSignal(this IHostApplicationBuilder builder)
Parameters
builderIHostApplicationBuilderThe host application builder.
Returns
- ISignalBuilder
A builder to register commands, handlers and extensions.
AddSignalApi(IHealthChecksBuilder, string, HealthStatus?, IEnumerable<string>?)
Adds a health check that calls GET /v1/health on the container.
public static IHealthChecksBuilder AddSignalApi(this IHealthChecksBuilder builder, string name = "signal-api", HealthStatus? failureStatus = null, IEnumerable<string>? tags = null)
Parameters
builderIHealthChecksBuilderThe health checks builder from
AddHealthChecks().namestringThe check name.
failureStatusHealthStatus?Status reported when unhealthy; defaults to Unhealthy.
tagsIEnumerable<string>Tags for filtering; defaults to
signal.
Returns
- IHealthChecksBuilder
builderfor chaining.