net.engio.mbassy

Interface PubSubSupport<T>

All Known Subinterfaces:

IMessageBus<T,P>, ISyncMessageBus<T,P>

All Known Implementing Classes:

AbstractSyncAsyncMessageBus, AbstractSyncMessageBus, MBassador, SyncMessageBus

public interface PubSubSupport<T>

This interface defines the very basic message publication semantics according to the publish subscribe pattern. Listeners can be subscribed and unsubscribed using the corresponding methods. When a listener is subscribed

Method Summary

Methods

Modifier and Type	Method and Description
void	publish(T message) Synchronously publish a message to all registered listeners (this includes listeners defined for super types) The call blocks until every messageHandler has processed the message.
void	subscribe(Object listener) Subscribe all handler of the given listener.
boolean	unsubscribe(Object listener) Immediately remove all registered message handlers (if any) of the given listener.

Method Detail

subscribe

void subscribe(Object listener)

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

Parameters:

listener -

unsubscribe

boolean unsubscribe(Object listener)

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 any object that is not subscribed will not have any effect and is silently ignored.

Parameters:

listener -

Returns:

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

publish

void publish(T message)

Synchronously publish a message to all registered listeners (this includes listeners defined for super types) The call blocks until every messageHandler has processed the message.

Parameters:

message -