HostingHostBuilderExtensions.UseConsoleLifetime Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.dll

Package:

Microsoft.Extensions.Hosting v10.0.0-preview.1.25080.5

Overloads

UseConsoleLifetime(IHostBuilder)	Listens for Ctrl+C or SIGTERM and calls StopApplication() to start the shutdown process. This will unblock extensions like RunAsync and WaitForShutdownAsync.
UseConsoleLifetime(IHostBuilder, Action<ConsoleLifetimeOptions>)	Listens for Ctrl+C or SIGTERM and calls StopApplication() to start the shutdown process. This will unblock extensions like RunAsync and WaitForShutdownAsync.

UseConsoleLifetime(IHostBuilder)

Source:

HostingHostBuilderExtensions.cs

Listens for Ctrl+C or SIGTERM and calls StopApplication() to start the shutdown process. This will unblock extensions like RunAsync and WaitForShutdownAsync.

C#

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static Microsoft.Extensions.Hosting.IHostBuilder UseConsoleLifetime(this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder);

Parameters

hostBuilder

IHostBuilder

The IHostBuilder to configure.

Returns

IHostBuilder

The same instance of the IHostBuilder for chaining.

Attributes

UnsupportedOSPlatformAttribute

UseConsoleLifetime(IHostBuilder, Action<ConsoleLifetimeOptions>)

Source:

HostingHostBuilderExtensions.cs

Listens for Ctrl+C or SIGTERM and calls StopApplication() to start the shutdown process. This will unblock extensions like RunAsync and WaitForShutdownAsync.

C#

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static Microsoft.Extensions.Hosting.IHostBuilder UseConsoleLifetime(this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder, Action<Microsoft.Extensions.Hosting.ConsoleLifetimeOptions> configureOptions);

Parameters

hostBuilder

IHostBuilder

The IHostBuilder to configure.

configureOptions

Action<ConsoleLifetimeOptions>

The delegate for configuring the ConsoleLifetime.

Returns

IHostBuilder

The same instance of the IHostBuilder for chaining.

Attributes

UnsupportedOSPlatformAttribute