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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ThreadFactory	AsynchronousHandlerThreadFactory
protected ThreadFactory	dispatcherThreadFactory
protected static ThreadFactory	DispatcherThreadFactory
protected ExecutorService	executor
protected MessagePublication.Factory	messagePublicationFactory
protected MetadataReader	metadataReader
protected int	numberOfMessageDispatchers
protected BlockingQueue<MessagePublication>	pendingMessagesQueue
protected SubscriptionFactory	subscriptionFactory

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()
MetadataReader	getMetadataReader()
int	getNumberOfMessageDispatchers()
BlockingQueue<MessagePublication>	getPendingMessagesQueue()
SubscriptionFactory	getSubscriptionFactory()
ThreadFactory	getThreadFactoryForAsynchronousMessageDispatch()
BusConfiguration	setExecutorForAsynchronousHandlers(ExecutorService executor)
BusConfiguration	setMessagePublicationFactory(MessagePublication.Factory messagePublicationFactory)
void	setMetadataReader(MetadataReader metadataReader)
BusConfiguration	setNumberOfMessageDispatchers(int numberOfMessageDispatchers)
void	setPendingMessagesQueue(BlockingQueue<MessagePublication> pendingMessagesQueue)
BusConfiguration	setSubscriptionFactory(SubscriptionFactory subscriptionFactory)
BusConfiguration	setThreadFactoryForAsynchronousMessageDispatch(ThreadFactory factory)

Methods inherited from class java.lang.Object

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

Field Detail

AsynchronousHandlerThreadFactory

protected static final ThreadFactory AsynchronousHandlerThreadFactory

DispatcherThreadFactory

protected static final ThreadFactory DispatcherThreadFactory

numberOfMessageDispatchers

protected int numberOfMessageDispatchers

executor

protected ExecutorService executor

subscriptionFactory

protected SubscriptionFactory subscriptionFactory

metadataReader

protected MetadataReader metadataReader

messagePublicationFactory

protected MessagePublication.Factory messagePublicationFactory

dispatcherThreadFactory

protected ThreadFactory dispatcherThreadFactory

pendingMessagesQueue

protected BlockingQueue<MessagePublication> pendingMessagesQueue

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()

Specified by:

getMessagePublicationFactory in interface ISyncBusConfiguration

setMessagePublicationFactory

public BusConfiguration setMessagePublicationFactory(MessagePublication.Factory messagePublicationFactory)

getMetadataReader

public MetadataReader getMetadataReader()

Specified by:

getMetadataReader in interface ISyncBusConfiguration

setMetadataReader

public void setMetadataReader(MetadataReader metadataReader)

getSubscriptionFactory

public SubscriptionFactory getSubscriptionFactory()

Specified by:

getSubscriptionFactory in interface ISyncBusConfiguration

setSubscriptionFactory

public BusConfiguration setSubscriptionFactory(SubscriptionFactory subscriptionFactory)