Class UDPBabelChannelBuilder

java.lang.Object

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

pt.unl.fct.di.novasys.babel2.channels.AbstractIPBabelChannelBuilder<UDPBabelChannelBuilder>

pt.unl.fct.di.novasys.babel2.channels.udp.UDPBabelChannelBuilder

All Implemented Interfaces:

BabelChannelBuilder

public class UDPBabelChannelBuilder
extends AbstractIPBabelChannelBuilder<UDPBabelChannelBuilder>

Builder / factory for UDPBabelChannel instances.

Configure the desired bind address and optional multicast parameters before building the channel:

BabelChannel channel = UDPBabelChannel.builder()
        .setBindingAddress(new InetSocketAddress("0.0.0.0", 7000))
        .build(babelRuntime, store, myself, protocol);

Once build(Babel, NodeStore, BabelNode, BabelProtocol) has been called, subsequent calls return the same UDPBabelChannel instance.

Field Summary

Fields inherited from class AbstractIPBabelChannelBuilder

DEFAULT_CONNECTION_UP_DELAY, DEFAULT_CONNECTION_UP_DELAY_UNIT

Modifier and Type	Field	Description
static final long	DEFAULT_CONNECTION_UP_DELAY	Default delay in milliseconds before dispatching connection-up notifications.
static final TimeUnit	DEFAULT_CONNECTION_UP_DELAY_UNIT	Default time unit for AbstractIPBabelChannelBuilder.DEFAULT_CONNECTION_UP_DELAY.

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
UDPBabelChannelBuilder()	Constructs a new UDPBabelChannelBuilder binding to the default port 7964.

Method Summary

Modifier and Type	Method	Description
UDPBabelChannelBuilder	addMulticastAddress(InetSocketAddress multicastAddress)	Adds a multicast group address to join and broadcast to.
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.
UDPBabelChannelBuilder	setNumberOfMulticastTtl(int multicastTtl)	Sets the Time-To-Live (TTL) hop count for outgoing multicast packets.

Methods inherited from class AbstractIPBabelChannelBuilder

getBindingAddress, getConnectionUpDelay, getConnectionUpDelayUnit, getEventLoopGroup, setBindingAddress, setConnectionUpDelay, setConnectionUpDelay, setEventLoopGroup

Modifier and Type	Method	Description
protected final InetSocketAddress	getBindingAddress()	Returns the currently configured binding address.
protected final long	getConnectionUpDelay()	Returns the configured connection up delay value.
protected final TimeUnit	getConnectionUpDelayUnit()	Returns the time unit of the connection up delay.
protected final io.netty.channel.EventLoopGroup	getEventLoopGroup()	Returns the configured event loop group, initializing a default one via BabelIpUtils.createLoopGroup() if none has been set.
final UDPBabelChannelBuilder	setBindingAddress(InetSocketAddress bindingAddress)	Sets the local IP socket address to which the channel should bind.
final UDPBabelChannelBuilder	setConnectionUpDelay(long delayMillis)	Sets the delay in milliseconds before notifying the runtime that a connection is fully up.
final UDPBabelChannelBuilder	setConnectionUpDelay(long delay, TimeUnit unit)	Sets the delay and unit before notifying the runtime that a connection is fully up.
final UDPBabelChannelBuilder	setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)	Configures the Netty EventLoopGroup used for network I/O.

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 UDPBabelChannelBuilder	setNumberOfConnections(int numberOfConnections)	Sets the default number of connections expected.
final UDPBabelChannelBuilder	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

UDPBabelChannelBuilder

public UDPBabelChannelBuilder()

Constructs a new UDPBabelChannelBuilder binding to the default port 7964.

Method Details

setNumberOfMulticastTtl

public UDPBabelChannelBuilder setNumberOfMulticastTtl(int multicastTtl)

Sets the Time-To-Live (TTL) hop count for outgoing multicast packets.

Parameters:

multicastTtl - the multicast TTL value

Returns:

this builder instance

Throws:

IllegalStateException - if the channel has already been built

addMulticastAddress

public UDPBabelChannelBuilder addMulticastAddress(InetSocketAddress multicastAddress)

Adds a multicast group address to join and broadcast to.

Parameters:

multicastAddress - the multicast socket address

Returns:

this builder instance

Throws:

IllegalArgumentException - if the provided address is not a multicast address

IllegalStateException - if the channel has already been built

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