ch.cmbntr.eventbus

Class EventBus

java.lang.Object

ch.cmbntr.eventbus.EventBus

All Implemented Interfaces:

Runnable

public class EventBus
extends Object
implements Runnable

Asynchronous event bus, which is compatible with the Guava EventBus (i.e. it uses Subscribe, AllowConcurrentEvents and DeadEvent).

Author:

Michael Locher

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventBus() Creates this, with a "default" identifier.
	EventBus(com.google.common.base.Function<? super Method,Handler> handlerBuilder, Executor dispatcher) Creates this.
protected	EventBus(com.google.common.base.Predicate<? super Method> isHandler, com.google.common.base.Function<? super Method,Handler> handlerBuilder, Executor dispatcher) Creates this.
	EventBus(String identifier) Creates this.
	EventBus(String identifier, boolean batchDispatching, Executor handlerExecutor, Executor dispatcher) Creates this.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispatch(Object event) Dispatches an event.
protected Set<Handler>	newHandlerSet() Provides a new empty set for handlers.
void	post(Object event) Posts an event to all registered handlers.
void	register(Object target) Registers all handler methods on object to receive events.
void	registerWeak(Object target) Registers all handler methods on object to receive events, but only keeps a weak reference to the object.
void	run()
void	unregister(Object target) Unregisters all handler methods on a registered object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBus

public EventBus()

Creates this, with a "default" identifier.

EventBus

public EventBus(String identifier)

Creates this. Will use a custom single thread for batched event dispatching and handling.

Parameters:

identifier - the bus identifier

EventBus

public EventBus(String identifier,
        boolean batchDispatching,
        Executor handlerExecutor,
        Executor dispatcher)

Creates this.

Parameters:

identifier - the bus identifier

batchDispatching - if true, event processing is batched (same thread per handler/event)

handlerExecutor - the executor which will performs the handler callbacks

dispatcher - the executor which will perform the dispatching

EventBus

public EventBus(com.google.common.base.Function<? super Method,Handler> handlerBuilder,
        Executor dispatcher)

Creates this.

Parameters:

handlerBuilder - the factory for handlers

dispatcher - the executor which will perform the dispatching

EventBus

protected EventBus(com.google.common.base.Predicate<? super Method> isHandler,
        com.google.common.base.Function<? super Method,Handler> handlerBuilder,
        Executor dispatcher)

Creates this.

Parameters:

isHandler - determines if a method is a handler

handlerBuilder - the factory for handlers

dispatcher - the executor which will perform the dispatching

Method Detail

newHandlerSet

protected Set<Handler> newHandlerSet()

Provides a new empty set for handlers. Note: the set must be thread-safe.

Returns:

a new set

dispatch

protected void dispatch(Object event)

Dispatches an event. Will be called from the dispatcher executor.

Parameters:

event - the event

post

public void post(Object event)

Posts an event to all registered handlers.

Parameters:

event - event to post.

run

public void run()

Specified by:

run in interface Runnable

register

public void register(Object target)

Registers all handler methods on object to receive events.

Parameters:

object - object whose handler methods should be registered.

registerWeak

public void registerWeak(Object target)

Registers all handler methods on object to receive events, but only keeps a weak reference to the object.

Parameters:

object - object whose handler methods should be registered.

unregister

public void unregister(Object target)

Unregisters all handler methods on a registered object.

Parameters:

object - object whose handler methods should be unregistered.