FakeHost.StopAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting.Testing

Assembly:: Microsoft.Extensions.Hosting.Testing.dll

Package:: Microsoft.Extensions.Hosting.Testing v9.0.0-preview.3.24209.3

Source:: FakeHost.cs

Source:: FakeHost.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.

Attempts to gracefully stop the program.

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

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

Public Function StopAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken: CancellationToken

Used to indicate when stop should no longer be graceful.

Returns

Task

A Task that will be completed when the IHost stops.

Implements

StopAsync(CancellationToken)

Exceptions

OperationCanceledException

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

Remarks

If no cancellation token is given, a new one using StartUpTimeout is used.

Applies to