Interface IEventBus
interface to be implemented by an event bus
Namespace: FastEndpoints
Assembly: FastEndpoints.dll
Syntax
public interface IEventBus
Methods
PublishAsync<TEvent>(TEvent, Mode, CancellationToken)
publishes a given event model to all subscribers registered to handle the that type of event.
Declaration
Task PublishAsync<TEvent>(TEvent eventModel, Mode waitMode = Mode.WaitForAll, CancellationToken cancellation = default) where TEvent : notnull
Parameters
Type | Name | Description |
---|---|---|
TEvent | eventModel | the notification event model/dto to publish |
Mode | waitMode | specify whether to wait for none, any or all of the subscribers to complete their work |
CancellationToken | cancellation | an optional cancellation token |
Returns
Type | Description |
---|---|
Task | a Task that matches the wait mode specified. WaitForNone returns an already completed Task (fire and forget). WaitForAny returns a Task that will complete when any of the subscribers complete their work. WaitForAll return a Task that will complete only when all of the subscribers complete their work. |
Type Parameters
Name | Description |
---|---|
TEvent | the type of the event model |