IDistributedApplicationEventingSubscriber Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /IDistributedApplicationEventingSubscriber
6. /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