net.engio.mbassy

Class AbstractMessageBus<T,P extends IMessageBus.IPostCommand>

java.lang.Object

net.engio.mbassy.AbstractMessageBus<T,P>

Type Parameters:

T -

P -

All Implemented Interfaces:

IMessageBus<T,P>

Direct Known Subclasses:

MBassador

public abstract class AbstractMessageBus<T,P extends IMessageBus.IPostCommand>
extends Object
implements IMessageBus<T,P>

The base class for all message bus implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface net.engio.mbassy.IMessageBus

IMessageBus.IPostCommand<T>

Constructor Summary

Constructors

Constructor and Description
AbstractMessageBus(BusConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
protected MessagePublication	addAsynchronousDeliveryRequest(MessagePublication request)
protected MessagePublication	addAsynchronousDeliveryRequest(MessagePublication request, long timeout, TimeUnit unit)
void	addErrorHandler(IPublicationErrorHandler handler) Publication errors may occur at various points of time during message delivery.
protected void	finalize()
Executor	getExecutor() Get the executor service that is used to asynchronous message publication.
Collection<IPublicationErrorHandler>	getRegisteredErrorHandlers() Returns an immutable collection containing all the registered error handlers
protected Collection<Subscription>	getSubscriptionsByMessageType(Class messageType)
void	handlePublicationError(PublicationError error)
boolean	hasPendingMessages() Check whether any asynchronous message publications are pending for being processed
void	subscribe(Object listener) Subscribe all listeners of the given message to receive message publications.
boolean	unsubscribe(Object listener) Immediately remove all registered message handlers (if any) of the given listener.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.engio.mbassy.IMessageBus

post

Constructor Detail

AbstractMessageBus

public AbstractMessageBus(BusConfiguration configuration)

Method Detail

getRegisteredErrorHandlers

public Collection<IPublicationErrorHandler> getRegisteredErrorHandlers()

Description copied from interface: IMessageBus

Returns an immutable collection containing all the registered error handlers

Specified by:

getRegisteredErrorHandlers in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

Returns:

unsubscribe

public boolean unsubscribe(Object listener)

Description copied from interface: IMessageBus

Immediately remove all registered message handlers (if any) of the given listener. When this call returns all handlers have effectively been removed and will not receive any message publications (including asynchronously scheduled publications that have been published when the message listener was still subscribed). A call to this method passing null, an already unsubscribed listener or any object that does not define any message handlers will not have any effect and is silently ignored.

Specified by:

unsubscribe in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

Returns:

true, if the listener was found and successfully removed false otherwise

subscribe

public void subscribe(Object listener)

Description copied from interface: IMessageBus

Subscribe all listeners of the given message to receive message publications. Any message may only be subscribed once (subsequent subscriptions of an already subscribed message will be silently ignored)

Specified by:

subscribe in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

addErrorHandler

public void addErrorHandler(IPublicationErrorHandler handler)

Description copied from interface: IMessageBus

Publication errors may occur at various points of time during message delivery. A handler may throw an exception, may not be accessible due to security constraints or is not annotated properly. In any of all possible cases a publication error is created and passed to each of the registered error handlers. A call to this method will add the given error handler to the chain

Specified by:

addErrorHandler in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

addAsynchronousDeliveryRequest

protected MessagePublication addAsynchronousDeliveryRequest(MessagePublication request)

addAsynchronousDeliveryRequest

protected MessagePublication addAsynchronousDeliveryRequest(MessagePublication request,
                                                long timeout,
                                                TimeUnit unit)

getSubscriptionsByMessageType

protected Collection<Subscription> getSubscriptionsByMessageType(Class messageType)

handlePublicationError

public void handlePublicationError(PublicationError error)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

hasPendingMessages

public boolean hasPendingMessages()

Description copied from interface: IMessageBus

Check whether any asynchronous message publications are pending for being processed

Specified by:

hasPendingMessages in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

Returns:

getExecutor

public Executor getExecutor()

Description copied from interface: IMessageBus

Get the executor service that is used to asynchronous message publication. The executor is passed to the message bus at creation time.

Specified by:

getExecutor in interface IMessageBus<T,P extends IMessageBus.IPostCommand>

Returns: