Class LocalDistributedEventBus

Inheritance
object
LocalDistributedEventBus
Implements
Inherited Members
Namespace: Volo.Abp.EventBus.Distributed
Assembly: Volo.Abp.EventBus.dll
Syntax
[Dependency(TryRegister = true)]
[ExposeServices(new Type[] { typeof(IDistributedEventBus), typeof(LocalDistributedEventBus) })]
public class LocalDistributedEventBus : IDistributedEventBus, IEventBus, ISingletonDependency

Constructors

LocalDistributedEventBus(ILocalEventBus, IServiceScopeFactory, IOptions<AbpDistributedEventBusOptions>)

Declaration
public LocalDistributedEventBus(ILocalEventBus localEventBus, IServiceScopeFactory serviceScopeFactory, IOptions<AbpDistributedEventBusOptions> distributedEventBusOptions)
Parameters
Type Name Description
ILocalEventBus localEventBus
IServiceScopeFactory serviceScopeFactory
IOptions<AbpDistributedEventBusOptions> distributedEventBusOptions

Properties

AbpDistributedEventBusOptions

Declaration
protected AbpDistributedEventBusOptions AbpDistributedEventBusOptions { get; }
Property Value
Type Description
AbpDistributedEventBusOptions

ServiceScopeFactory

Declaration
protected IServiceScopeFactory ServiceScopeFactory { get; }
Property Value
Type Description
IServiceScopeFactory

Methods

PublishAsync(Type, object, bool)

Declaration
public Task PublishAsync(Type eventType, object eventData, bool onUnitOfWorkComplete = true)
Parameters
Type Name Description
Type eventType
object eventData
bool onUnitOfWorkComplete
Returns
Type Description
Task

PublishAsync(Type, object, bool, bool)

Declaration
public Task PublishAsync(Type eventType, object eventData, bool onUnitOfWorkComplete = true, bool useOutbox = true)
Parameters
Type Name Description
Type eventType
object eventData
bool onUnitOfWorkComplete
bool useOutbox
Returns
Type Description
Task

PublishAsync<TEvent>(TEvent, bool)

Declaration
public Task PublishAsync<TEvent>(TEvent eventData, bool onUnitOfWorkComplete = true) where TEvent : class
Parameters
Type Name Description
TEvent eventData
bool onUnitOfWorkComplete
Returns
Type Description
Task
Type Parameters
Name Description
TEvent

PublishAsync<TEvent>(TEvent, bool, bool)

Declaration
public Task PublishAsync<TEvent>(TEvent eventData, bool onUnitOfWorkComplete = true, bool useOutbox = true) where TEvent : class
Parameters
Type Name Description
TEvent eventData
bool onUnitOfWorkComplete
bool useOutbox
Returns
Type Description
Task
Type Parameters
Name Description
TEvent

Subscribe(Type, IEventHandler)

Declaration
public IDisposable Subscribe(Type eventType, IEventHandler handler)
Parameters
Type Name Description
Type eventType
IEventHandler handler
Returns
Type Description
IDisposable

Subscribe(Type, IEventHandlerFactory)

Declaration
public IDisposable Subscribe(Type eventType, IEventHandlerFactory factory)
Parameters
Type Name Description
Type eventType
IEventHandlerFactory factory
Returns
Type Description
IDisposable

Subscribe(ITypeList<IEventHandler>)

Declaration
public virtual void Subscribe(ITypeList<IEventHandler> handlers)
Parameters
Type Name Description
ITypeList<IEventHandler> handlers

Subscribe<TEvent>(Func<TEvent, Task>)

Declaration
public IDisposable Subscribe<TEvent>(Func<TEvent, Task> action) where TEvent : class
Parameters
Type Name Description
Func<TEvent, Task> action
Returns
Type Description
IDisposable
Type Parameters
Name Description
TEvent

Subscribe<TEvent>(IDistributedEventHandler<TEvent>)

Declaration
public virtual IDisposable Subscribe<TEvent>(IDistributedEventHandler<TEvent> handler) where TEvent : class
Parameters
Type Name Description
IDistributedEventHandler<TEvent> handler
Returns
Type Description
IDisposable
Type Parameters
Name Description
TEvent

Subscribe<TEvent>(IEventHandlerFactory)

Declaration
public IDisposable Subscribe<TEvent>(IEventHandlerFactory factory) where TEvent : class
Parameters
Type Name Description
IEventHandlerFactory factory
Returns
Type Description
IDisposable
Type Parameters
Name Description
TEvent

Subscribe<TEvent>(ILocalEventHandler<TEvent>)

Declaration
public IDisposable Subscribe<TEvent>(ILocalEventHandler<TEvent> handler) where TEvent : class
Parameters
Type Name Description
ILocalEventHandler<TEvent> handler
Returns
Type Description
IDisposable
Type Parameters
Name Description
TEvent

Subscribe<TEvent, THandler>()

Declaration
public IDisposable Subscribe<TEvent, THandler>() where TEvent : class where THandler : IEventHandler, new()
Returns
Type Description
IDisposable
Type Parameters
Name Description
TEvent
THandler

Unsubscribe(Type, IEventHandler)

Declaration
public void Unsubscribe(Type eventType, IEventHandler handler)
Parameters
Type Name Description
Type eventType
IEventHandler handler

Unsubscribe(Type, IEventHandlerFactory)

Declaration
public void Unsubscribe(Type eventType, IEventHandlerFactory factory)
Parameters
Type Name Description
Type eventType
IEventHandlerFactory factory

UnsubscribeAll(Type)

Declaration
public void UnsubscribeAll(Type eventType)
Parameters
Type Name Description
Type eventType

UnsubscribeAll<TEvent>()

Declaration
public void UnsubscribeAll<TEvent>() where TEvent : class
Type Parameters
Name Description
TEvent

Unsubscribe<TEvent>(Func<TEvent, Task>)

Declaration
public void Unsubscribe<TEvent>(Func<TEvent, Task> action) where TEvent : class
Parameters
Type Name Description
Func<TEvent, Task> action
Type Parameters
Name Description
TEvent

Unsubscribe<TEvent>(IEventHandlerFactory)

Declaration
public void Unsubscribe<TEvent>(IEventHandlerFactory factory) where TEvent : class
Parameters
Type Name Description
IEventHandlerFactory factory
Type Parameters
Name Description
TEvent

Unsubscribe<TEvent>(ILocalEventHandler<TEvent>)

Declaration
public void Unsubscribe<TEvent>(ILocalEventHandler<TEvent> handler) where TEvent : class
Parameters
Type Name Description
ILocalEventHandler<TEvent> handler
Type Parameters
Name Description
TEvent

Implements

Extension Methods