net.engio.mbassy.bus.config

Class BusConfiguration

java.lang.Object

net.engio.mbassy.bus.config.BusConfiguration

All Implemented Interfaces:

IBusConfiguration, ISyncBusConfiguration

public class BusConfiguration
extends Object
implements IBusConfiguration

The bus configuration holds various parameters that can be used to customize the bus' runtime behaviour.

Author:

bennidi Date: 12/8/12

Method Summary

Methods

Modifier and Type	Method and Description
static BusConfiguration	Default() Creates a new instance, using the Default settings of 2 dispatchers, and asynchronous handlers with an initial count equal to the number of available processors in the machine, with maximum count equal to 2 * the number of available processors.
static BusConfiguration	Default(int numberOfDispatchers) Creates a new instance, using the specified number of dispatchers, and asynchronous handlers with an initial count equal to the number of available processors in the machine, with maximum count equal to 2 * the number of available processors.
static BusConfiguration	Default(int numberOfDispatchers, int initialCoreThreads, int maximumCoreThreads) Creates a new instance, using the specified number of dispatchers, and asynchronous handlers with initial threads and maximum threads specified by the calling parameters.
static BusConfiguration	Default(int numberOfDispatchers, ThreadPoolExecutor executor) Creates a new instance, using the specified number of dispatchers, and asynchronous handlers that use the provided ThreadPoolExecutor.
static BusConfiguration	Empty()
ExecutorService	getExecutorForAsynchronousHandlers()
MessagePublication.Factory	getMessagePublicationFactory() The message publication factory is used to wrap a published message and while it is being processed
MetadataReader	getMetadataReader()
int	getNumberOfMessageDispatchers()
BlockingQueue<MessagePublication>	getPendingMessagesQueue()
SubscriptionFactory	getSubscriptionFactory()
ISubscriptionManagerProvider	getSubscriptionManagerProvider()
ThreadFactory	getThreadFactoryForAsynchronousMessageDispatch()
BusConfiguration	setExecutorForAsynchronousHandlers(ExecutorService executor)
BusConfiguration	setMessagePublicationFactory(MessagePublication.Factory messagePublicationFactory)
BusConfiguration	setMetadataReader(MetadataReader metadataReader)
BusConfiguration	setNumberOfMessageDispatchers(int numberOfMessageDispatchers)
void	setPendingMessagesQueue(BlockingQueue<MessagePublication> pendingMessagesQueue)
BusConfiguration	setSubscriptionFactory(SubscriptionFactory subscriptionFactory)
BusConfiguration	setSubscriptionManagerProvider(ISubscriptionManagerProvider subscriptionManagerProvider)
BusConfiguration	setThreadFactoryForAsynchronousMessageDispatch(ThreadFactory factory)

Methods inherited from class java.lang.Object

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

Method Detail

Default

public static BusConfiguration Default()

Creates a new instance, using the Default settings of 2 dispatchers, and asynchronous handlers with an initial count equal to the number of available processors in the machine, with maximum count equal to 2 * the number of available processors. Uses Runtime.availableProcessors() to determine the number of available processors

Returns:

a Default BusConfiguration

Default

public static BusConfiguration Default(int numberOfDispatchers)

Creates a new instance, using the specified number of dispatchers, and asynchronous handlers with an initial count equal to the number of available processors in the machine, with maximum count equal to 2 * the number of available processors. Uses Runtime.availableProcessors() to determine the number of available processors

Returns:

a Default BusConfiguration

Default

public static BusConfiguration Default(int numberOfDispatchers,
                       int initialCoreThreads,
                       int maximumCoreThreads)

Creates a new instance, using the specified number of dispatchers, and asynchronous handlers with initial threads and maximum threads specified by the calling parameters.

Returns:

a Default BusConfiguration

Default

public static BusConfiguration Default(int numberOfDispatchers,
                       ThreadPoolExecutor executor)

Creates a new instance, using the specified number of dispatchers, and asynchronous handlers that use the provided ThreadPoolExecutor.

Returns:

a Default BusConfiguration

Empty

public static BusConfiguration Empty()

setPendingMessagesQueue

public void setPendingMessagesQueue(BlockingQueue<MessagePublication> pendingMessagesQueue)

getNumberOfMessageDispatchers

public int getNumberOfMessageDispatchers()

Specified by:

getNumberOfMessageDispatchers in interface IBusConfiguration

setNumberOfMessageDispatchers

public BusConfiguration setNumberOfMessageDispatchers(int numberOfMessageDispatchers)

getExecutorForAsynchronousHandlers

public ExecutorService getExecutorForAsynchronousHandlers()

Specified by:

getExecutorForAsynchronousHandlers in interface IBusConfiguration

getPendingMessagesQueue

public BlockingQueue<MessagePublication> getPendingMessagesQueue()

Specified by:

getPendingMessagesQueue in interface IBusConfiguration

getThreadFactoryForAsynchronousMessageDispatch

public ThreadFactory getThreadFactoryForAsynchronousMessageDispatch()

Specified by:

getThreadFactoryForAsynchronousMessageDispatch in interface IBusConfiguration

setThreadFactoryForAsynchronousMessageDispatch

public BusConfiguration setThreadFactoryForAsynchronousMessageDispatch(ThreadFactory factory)

setExecutorForAsynchronousHandlers

public BusConfiguration setExecutorForAsynchronousHandlers(ExecutorService executor)

getMessagePublicationFactory

public MessagePublication.Factory getMessagePublicationFactory()

Description copied from interface: ISyncBusConfiguration

The message publication factory is used to wrap a published message and while it is being processed

Specified by:

getMessagePublicationFactory in interface ISyncBusConfiguration

Returns:

The factory to be used by the bus to create the publications

setMessagePublicationFactory

public BusConfiguration setMessagePublicationFactory(MessagePublication.Factory messagePublicationFactory)

getMetadataReader

public MetadataReader getMetadataReader()

Specified by:

getMetadataReader in interface ISyncBusConfiguration

setMetadataReader

public BusConfiguration setMetadataReader(MetadataReader metadataReader)

getSubscriptionFactory

public SubscriptionFactory getSubscriptionFactory()

Specified by:

getSubscriptionFactory in interface ISyncBusConfiguration

setSubscriptionFactory

public BusConfiguration setSubscriptionFactory(SubscriptionFactory subscriptionFactory)

getSubscriptionManagerProvider

public ISubscriptionManagerProvider getSubscriptionManagerProvider()

Specified by:

getSubscriptionManagerProvider in interface ISyncBusConfiguration

setSubscriptionManagerProvider

public BusConfiguration setSubscriptionManagerProvider(ISubscriptionManagerProvider subscriptionManagerProvider)