DistributedApplication.RunAsync(CancellationToken) Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.0.0

Package:: Aspire.Hosting v8.0.1

Source:: DistributedApplication.cs

Source:: DistributedApplication.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered and all IHostedService instances are stopped.

public virtual System.Threading.Tasks.Task RunAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member RunAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RunAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function RunAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken: CancellationToken

The token to trigger shutdown.

Returns

Task

The Task that represents the asynchronous operation.

Remarks

When the .NET Aspire app host is launched via RunAsync(CancellationToken) there are two possible modes that it is running in:

Developers extending the .NET Aspire application model should consider the lifetime of IHostedService instances which are added to the dependency injection container. For more information on determining the mode that the app host is running in refer to DistributedApplicationExecutionContext.

Applies to

Share via