net.engio.mbassy.bus

Class AbstractPubSubSupport<T>

java.lang.Object

net.engio.mbassy.bus.AbstractPubSubSupport<T>

Type Parameters:

T -

All Implemented Interfaces:

PubSubSupport<T>, RuntimeProvider

Direct Known Subclasses:

AbstractSyncAsyncMessageBus, SyncMessageBus

public abstract class AbstractPubSubSupport<T>
extends Object
implements PubSubSupport<T>

The base class for all message bus implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_HANDLER_MSG

Constructor Summary

Constructors

Constructor and Description
AbstractPubSubSupport(BusConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
Collection<IPublicationErrorHandler>	getRegisteredErrorHandlers()
BusRuntime	getRuntime()
void	subscribe(Object listener) Subscribe all handlers of the given listener.
String	toString()
boolean	unsubscribe(Object listener) Immediately remove all registered message handlers (if any) of the given listener.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.engio.mbassy.bus.common.PubSubSupport

publish

Field Detail

ERROR_HANDLER_MSG

public static final String ERROR_HANDLER_MSG

See Also:

Constant Field Values

Constructor Detail

AbstractPubSubSupport

public AbstractPubSubSupport(BusConfiguration configuration)

Method Detail

getRegisteredErrorHandlers

public Collection<IPublicationErrorHandler> getRegisteredErrorHandlers()

unsubscribe

public boolean unsubscribe(Object listener)

Description copied from interface: PubSubSupport

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 messages (provided that running publications (iterators) in other threads have not yet obtained a reference to the listener)

A call to this method passing any object that is not subscribed will not have any effect and is silently ignored.

Specified by:

unsubscribe in interface PubSubSupport<T>

Returns:

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

subscribe

public void subscribe(Object listener)

Description copied from interface: PubSubSupport

Subscribe all handlers of the given listener. Any listener is only subscribed once -> subsequent subscriptions of an already subscribed listener will be silently ignored

Specified by:

subscribe in interface PubSubSupport<T>

getRuntime

public BusRuntime getRuntime()

Specified by:

getRuntime in interface RuntimeProvider

toString

public String toString()

Overrides:

toString in class Object