IDistributedApplicationEventingSubscriber Methods

Docs/Reference/Search C# APIs/Aspire.Hosting/IDistributedApplicationEventingSubscriber/Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting IDistributedApplicationEventingSubscriber Methods

InterfaceMethods1 member

Defines an interface for services that want to subscribe to events from IDistributedApplicationEventing. This allows a service to subscribe to BeforeStartEvent before the application actually starts.

SubscribeAsync(IDistributedApplicationEventing, DistributedApplicationExecutionContext, CancellationToken)abstractTask

Callback during which the service should subscribe to global events from IDistributedApplicationEventing.

public interface IDistributedApplicationEventingSubscriber
{
    public abstract Task SubscribeAsync(
        IDistributedApplicationEventing eventing,
        DistributedApplicationExecutionContext executionContext,
        CancellationToken cancellationToken)
    {
        // ...
    }
}

Parameters

eventingIDistributedApplicationEventingThe IDistributedApplicationEventing service to subscribe to events from.

executionContextDistributedApplicationExecutionContextThe DistributedApplicationExecutionContext instance for the run.

cancellationTokenCancellationTokenCancellation token from the service collection

Returns

TaskA task indicating event registration is complete