Class AsyncEventBus

java.lang.Object

com.google.common.eventbus.EventBus

com.google.common.eventbus.AsyncEventBus

public class AsyncEventBus
extends EventBus

An EventBus that takes the Executor of your choice and uses it to dispatch events, allowing dispatch to occur asynchronously.

Since:

10.0

Author:

Cliff Biffle

Constructor Summary

Constructors

Constructor	Description
AsyncEventBus(String identifier, Executor executor)	Creates a new AsyncEventBus that will use executor to dispatch events.
AsyncEventBus(Executor executor)	Creates a new AsyncEventBus that will use executor to dispatch events.
AsyncEventBus(Executor executor, SubscriberExceptionHandler subscriberExceptionHandler)	Creates a new AsyncEventBus that will use executor to dispatch events.

Method Summary

Methods inherited from class EventBus

identifier, post, register, toString, unregister

Modifier and Type	Method	Description
final String	identifier()	Returns the identifier for this event bus.
void	post(Object event)	Posts an event to all registered subscribers.
void	register(Object object)	Registers all subscriber methods on object to receive events.
String	toString()
void	unregister(Object object)	Unregisters all subscriber methods on a registered object.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AsyncEventBus

public AsyncEventBus(String identifier,
 Executor executor)

Creates a new AsyncEventBus that will use executor to dispatch events. Assigns identifier as the bus's name for logging purposes.

Parameters:

identifier - short name for the bus, for logging purposes.

executor - Executor to use to dispatch events. It is the caller's responsibility to shut down the executor after the last event has been posted to this event bus.

AsyncEventBus

public AsyncEventBus(Executor executor,
 SubscriberExceptionHandler subscriberExceptionHandler)

Creates a new AsyncEventBus that will use executor to dispatch events.

Parameters:

executor - Executor to use to dispatch events. It is the caller's responsibility to shut down the executor after the last event has been posted to this event bus.

subscriberExceptionHandler - Handler used to handle exceptions thrown from subscribers. See SubscriberExceptionHandler for more information.

Since:

16.0

AsyncEventBus

public AsyncEventBus(Executor executor)

Creates a new AsyncEventBus that will use executor to dispatch events.

Parameters:

executor - Executor to use to dispatch events. It is the caller's responsibility to shut down the executor after the last event has been posted to this event bus.