Class InternalBabelChannelBuilder

java.lang.Object

pt.unl.fct.di.novasys.babel2.channels.AbstractBabelChannelBuilder<InternalBabelChannelBuilder>

pt.unl.fct.di.novasys.babel2.channels.internal.InternalBabelChannelBuilder

All Implemented Interfaces:

BabelChannelBuilder

public final class InternalBabelChannelBuilder
extends AbstractBabelChannelBuilder<InternalBabelChannelBuilder>

BabelChannelBuilder that creates (and caches) a single InternalBabelChannel instance.

Because the internal channel simulates in-JVM communication, all protocols in the same process share the same channel instance. The first call to build(Babel, NodeStore, BabelNode, BabelProtocol) allocates the channel; subsequent calls return the same object.

Obtain an instance via InternalBabelChannel.builder().

Field Summary

Fields inherited from class AbstractBabelChannelBuilder

DEFAULT_NUMBER_OF_CONNECTIONS, DEFAULT_NUMBER_OF_MESSAGES

Modifier and Type	Field	Description
static final int	DEFAULT_NUMBER_OF_CONNECTIONS	Default number of connections to expect when initializing the channel.
static final int	DEFAULT_NUMBER_OF_MESSAGES	Default number of message types expected by this channel.

Constructor Summary

Constructors

Constructor	Description
InternalBabelChannelBuilder()	Constructs a new InternalBabelChannelBuilder.

Method Summary

Modifier and Type	Method	Description
BabelChannel	build(Babel runtime, NodeStore store, BabelNode identity, BabelProtocol protocol)	Creates a new BabelChannel instance, registering it with the given runtime and limiting its interest to the provided message types.
InternalBabelChannel	getCreatedInstance()	Returns the InternalBabelChannel previously created by build(Babel, NodeStore, BabelNode, BabelProtocol).

Methods inherited from class AbstractBabelChannelBuilder

getChannel, getNumberOfConnections, getNumberOfMessages, setChannel, setNumberOfConnections, setNumberOfMessages, validateStateOrThrow

Modifier and Type	Method	Description
protected final @Nullable BabelChannel	getChannel()	Returns the channel instance created by this builder, or null if not yet built.
protected final int	getNumberOfConnections()	Gets the expected number of connections set in this builder.
protected final int	getNumberOfMessages()	Gets the expected number of messages set in this builder.
protected final void	setChannel(BabelChannel channel)	Sets the constructed channel instance created by this builder.
final InternalBabelChannelBuilder	setNumberOfConnections(int numberOfConnections)	Sets the default number of connections expected.
final InternalBabelChannelBuilder	setNumberOfMessages(int numberOfMessages)	Sets the expected number of distinct message types handled by this channel.
protected final void	validateStateOrThrow()	Validates that this builder has not yet built its channel instance.

Methods inherited from class Object

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

Constructor Details

InternalBabelChannelBuilder

public InternalBabelChannelBuilder()

Constructs a new InternalBabelChannelBuilder.

Method Details

getCreatedInstance

public InternalBabelChannel getCreatedInstance()

Returns the InternalBabelChannel previously created by build(Babel, NodeStore, BabelNode, BabelProtocol).

Returns:

the created channel

Throws:

IllegalStateException - if build(Babel, NodeStore, BabelNode, BabelProtocol) has not been called yet

build

public BabelChannel build(Babel runtime,
 NodeStore store,
 BabelNode identity,
 BabelProtocol protocol)

Description copied from interface: BabelChannelBuilder

Creates a new BabelChannel instance, registering it with the given runtime and limiting its interest to the provided message types.

Parameters:

runtime - the owning Babel runtime

store - the NodeStore that will be used by this channel

identity - BabelNode object used to represent this Babel instance to other instances

protocol - the protocol instance associated with this channel

Returns:

a ready-to-use BabelChannel