com.diffplug.common.eventbus.AsyncEventBus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of durian-eventbus Show documentation
Durian - Guava's spikier (unofficial) cousin
There is a newer version: 1.2.0
/*
 * Original Guava code is copyright (C) 2015 The Guava Authors.
 * Modifications from Guava are copyright (C) 2016 DiffPlug.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.diffplug.common.eventbus;

import java.util.concurrent.Executor;

import com.diffplug.common.annotations.Beta;

/**
 * An {@link EventBus} that takes the Executor of your choice and uses it to
 * dispatch events, allowing dispatch to occur asynchronously.
 *
 * @author Cliff Biffle
 * @since 10.0
 */
@Beta
public class AsyncEventBus extends EventBus {

	/**
	 * Creates a new AsyncEventBus that will use {@code executor} to dispatch
	 * events.  Assigns {@code identifier} as the bus's name for logging purposes.
	 *
	 * @param identifier short name for the bus, for logging purposes.
	 * @param 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.
	 */
	public AsyncEventBus(String identifier, Executor executor) {
		super(identifier, executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE);
	}

	/**
	 * Creates a new AsyncEventBus that will use {@code executor} to dispatch
	 * events.
	 *
	 * @param 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.
	 * @param subscriberExceptionHandler Handler used to handle exceptions thrown from subscribers.
	 *    See {@link SubscriberExceptionHandler} for more information.
	 * @since 16.0
	 */
	public AsyncEventBus(Executor executor, SubscriberExceptionHandler subscriberExceptionHandler) {
		super("default", executor, Dispatcher.legacyAsync(), subscriberExceptionHandler);
	}

	/**
	 * Creates a new AsyncEventBus that will use {@code executor} to dispatch
	 * events.
	 *
	 * @param 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.
	 */
	public AsyncEventBus(Executor executor) {
		super("default", executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE);
	}
}