HostingHostBuilderExtensions.RunConsoleAsync Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.dll

Package:

Microsoft.Extensions.Hosting v9.0.0

Overloads

RunConsoleAsync(IHostBuilder, CancellationToken)	Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.
RunConsoleAsync(IHostBuilder, Action<ConsoleLifetimeOptions>, CancellationToken)	Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.

RunConsoleAsync(IHostBuilder, CancellationToken)

Source:

HostingHostBuilderExtensions.cs

Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static System.Threading.Tasks.Task RunConsoleAsync (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder, System.Threading.CancellationToken cancellationToken = default);

[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member RunConsoleAsync : Microsoft.Extensions.Hosting.IHostBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function RunConsoleAsync (hostBuilder As IHostBuilder, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

hostBuilder

IHostBuilder

The IHostBuilder to configure.

cancellationToken

CancellationToken

A CancellationToken that can be used to cancel the console.

Returns

Task

A Task that only completes when the token is triggered or shutdown is triggered.

Attributes

UnsupportedOSPlatformAttribute

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

RunConsoleAsync(IHostBuilder, Action<ConsoleLifetimeOptions>, CancellationToken)

Source:

HostingHostBuilderExtensions.cs

Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static System.Threading.Tasks.Task RunConsoleAsync (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder, Action<Microsoft.Extensions.Hosting.ConsoleLifetimeOptions> configureOptions, System.Threading.CancellationToken cancellationToken = default);

[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member RunConsoleAsync : Microsoft.Extensions.Hosting.IHostBuilder * Action<Microsoft.Extensions.Hosting.ConsoleLifetimeOptions> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function RunConsoleAsync (hostBuilder As IHostBuilder, configureOptions As Action(Of ConsoleLifetimeOptions), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

hostBuilder

IHostBuilder

The IHostBuilder to configure.

configureOptions

Action<ConsoleLifetimeOptions>

The delegate for configuring the ConsoleLifetime.

cancellationToken

CancellationToken

A CancellationToken that can be used to cancel the console.

Returns

Task

A Task that only completes when the token is triggered or shutdown is triggered.

Attributes

UnsupportedOSPlatformAttribute

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.