DistributedApplicationEventing Methods

ClassMethods5 members

Supports publishing and subscribing to events which are executed during the AppHost lifecycle.

PublishAsync(T, CancellationToken)Task

Publishes an event to all subscribes of the specific event type.

public class DistributedApplicationEventing
{
    public Task PublishAsync<T>(
        T @event,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationEventing.cs#L20

Parameters

eventTThe event.

cancellationTokenCancellationTokenoptionalA cancellation token.

Returns

TaskA task that can be awaited.

PublishAsync(T, EventDispatchBehavior, CancellationToken)Task

Publishes an event to all subscribes of the specific event type.

public class DistributedApplicationEventing
{
    public Task PublishAsync<T>(
        T @event,
        EventDispatchBehavior dispatchBehavior,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

DistributedApplicationEventing.cs#L20

Parameters

eventTThe event.

dispatchBehaviorEventDispatchBehaviorThe dispatch behavior for the event.

cancellationTokenCancellationTokenoptionalA cancellation token.

Returns

TaskA task that can be awaited.

Subscribe(Func<T, CancellationToken, Task>)DistributedApplicationEventSubscription

Subscribes a callback to a specific event type within the AppHost.

public class DistributedApplicationEventing
{
    public DistributedApplicationEventSubscription Subscribe<T>(
        Func<T, CancellationToken, Task> callback)
    {
        // ...
    }
}

DistributedApplicationEventing.cs#L122-L150

Parameters

callbackFunc<T, CancellationToken, Task>A callback to handle the event.

Returns

DistributedApplicationEventSubscriptionA subscription instance which can be used to unsubscribe

Subscribe(IResource, Func<T, CancellationToken, Task>)DistributedApplicationEventSubscription

Subscribes a callback to a specific event type

public class DistributedApplicationEventing
{
    public DistributedApplicationEventSubscription Subscribe<T>(
        IResource resource,
        Func<T, CancellationToken, Task> callback)
    {
        // ...
    }
}

DistributedApplicationEventing.cs#L161-L169

Parameters

resourceIResourceThe resource instance associated with the event.

callbackFunc<T, CancellationToken, Task>A callback to handle the event.

Returns

DistributedApplicationEventSubscriptionA subscription instance which can be used to unsubscribe.

Unsubscribe(DistributedApplicationEventSubscription)

Unsubscribe from an event.

public class DistributedApplicationEventing
{
    public void Unsubscribe(
        DistributedApplicationEventSubscription subscription)
    {
        // ...
    }
}

DistributedApplicationEventing.cs#L175-L183

Parameters

subscriptionDistributedApplicationEventSubscriptionThe specific subscription to unsubscribe.