IHost Interface

  • Reference

Definition

Namespace:
Microsoft.Extensions.Hosting
Assembly:
Microsoft.Extensions.Hosting.Abstractions.dll
Package:
Microsoft.Extensions.Hosting.Abstractions v8.0.1
Package:
Microsoft.Extensions.Hosting.Abstractions v9.0.0-rc.2.24473.5
Source:
IHost.cs
Source:
IHost.cs
Source:
IHost.cs
Source:
IHost.cs
Source:
IHost.cs

A program abstraction.

public interface class IHost : IDisposable
public interface IHost : IDisposable
type IHost = interface
    interface IDisposable
Public Interface IHost
Implements IDisposable
Derived
Implements
IDisposable

Properties

Services

Gets the services configured for the program (for example, using ConfigureServices(Action<HostBuilderContext,IServiceCollection>)).

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)
StartAsync(CancellationToken)

Starts the IHostedService objects configured for the program. The application will run until interrupted or until StopApplication() is called.
StopAsync(CancellationToken)

Attempts to gracefully stop the program.

Extension Methods

GetFakeLogCollector(IHost)

Gets the object that collects log records sent to the fake logger.
GetFakeRedactionCollector(IHost)

Gets the object reporting all redactions performed.
Run(IHost)

Runs an application and block the calling thread until host shutdown.
RunAsync(IHost, CancellationToken)

Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered. The host instance is disposed of after running.
Start(IHost)

Starts the host synchronously.
StopAsync(IHost, TimeSpan)

Attempts to gracefully stop the host with the given timeout.
WaitForShutdown(IHost)

Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
WaitForShutdownAsync(IHost, CancellationToken)

Returns a Task that completes when shutdown is triggered via the given token.

Applies to