net.engio.mbassy.bus

Interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

All Known Subinterfaces:

IMessageBus<T,P>

All Known Implementing Classes:

AbstractSyncAsyncMessageBus, AbstractSyncMessageBus, MBassador

public interface ISyncMessageBus<T,P extends ISyncMessageBus.ISyncPostCommand>

Author:

bennidi Date: 3/29/13

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISyncMessageBus.ISyncPostCommand A post command is used as an intermediate object created by a call to the message bus' post method.

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandler(IPublicationErrorHandler errorHandler) Publication errors may occur at various points of time during message delivery.
Collection<IPublicationErrorHandler>	getRegisteredErrorHandlers() Returns an immutable collection containing all the registered error handlers
P	post(T message)
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.

Method Detail

subscribe

void subscribe(Object listener)

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)

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 null, an already unsubscribed listener or any object that does not define any message handlers will not have any effect and is silently ignored.

Parameters:

listener -

Returns:

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

post

P post(T message)

Parameters:

message -

Returns:

addErrorHandler

void addErrorHandler(IPublicationErrorHandler errorHandler)

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

Parameters:

errorHandler -

getRegisteredErrorHandlers

Collection<IPublicationErrorHandler> getRegisteredErrorHandlers()

Returns an immutable collection containing all the registered error handlers

Returns: