Class QUICBabelChannelBuilder

java.lang.Object

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

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

pt.unl.fct.di.novasys.babel2.channels.quic.QUICBabelChannelBuilder

All Implemented Interfaces:

BabelChannelBuilder

public class QUICBabelChannelBuilder
extends AbstractIPBabelChannelBuilder<QUICBabelChannelBuilder>

Builder for QUICBabelChannel instances.

Configures channel parameters such as the local binding address, event loop group, number of streams, TLS trust manager, and identity keys prior to building the channel via the Babel runtime. Example usage:

QUICBabelChannelBuilder builder = QUICBabelChannel.builder()
        .setBindingAddress(new InetSocketAddress("0.0.0.0", 7000))
        .setNumberOfStreams(4)
        .setNumberOfConnections(100)
        .setTrustManagerFactory(new PeerIdentityTrustManagerFactory());

When registered with Babel via Babel.builder().registerProtocol(protocol, holderFactory, builder), build(Babel, NodeStore, BabelNode, BabelProtocol) is invoked for each registering protocol. The underlying QUICBabelChannel is created on the first invocation and shared, returning a dedicated QUICBabelChannelProtocolWrapper for each registering protocol.

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.

Method Summary

Modifier and Type	Method	Description
BabelChannel	build(Babel runtime, NodeStore store, BabelNode identity, BabelProtocol protocol)	Builds the channel or returns a protocol-specific wrapper if the underlying channel has already been constructed.
QUICBabelChannelBuilder	setComparator(Comparator<? extends BabelNode> comparator)	Sets the comparator used to resolve simultaneous-connection conflicts.
QUICBabelChannelBuilder	setKeyMaterial(CertGenerator.KeyMaterial keyMaterial)	Sets pre-generated CertGenerator.KeyMaterial containing the ephemeral key and certificate.
QUICBabelChannelBuilder	setNumberOfStreams(int numberOfStreams)	Sets the maximum number of concurrent unidirectional streams per connection.
QUICBabelChannelBuilder	setTrustManager(TrustManager trustManager)	Sets the TrustManager used to validate peer TLS certificates during the QUIC handshake.
QUICBabelChannelBuilder	setTrustManagerFactory(TrustManagerFactory trustManager)	Sets the TrustManagerFactory used to validate peer TLS certificates during the QUIC handshake.

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 QUICBabelChannelBuilder	setBindingAddress(InetSocketAddress bindingAddress)	Sets the local IP socket address to which the channel should bind.
final QUICBabelChannelBuilder	setConnectionUpDelay(long delayMillis)	Sets the delay in milliseconds before notifying the runtime that a connection is fully up.
final QUICBabelChannelBuilder	setConnectionUpDelay(long delay, TimeUnit unit)	Sets the delay and unit before notifying the runtime that a connection is fully up.
final QUICBabelChannelBuilder	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 QUICBabelChannelBuilder	setNumberOfConnections(int numberOfConnections)	Sets the default number of connections expected.
final QUICBabelChannelBuilder	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

Method Details

setNumberOfStreams

public QUICBabelChannelBuilder setNumberOfStreams(int numberOfStreams)

Sets the maximum number of concurrent unidirectional streams per connection. Also ensures the trust manager is initialized to InsecureTrustManagerFactory.INSTANCE if not already customized.

Parameters:

numberOfStreams - the number of unidirectional streams to configure

Returns:

this builder instance for method chaining

setTrustManagerFactory

public QUICBabelChannelBuilder setTrustManagerFactory(TrustManagerFactory trustManager)

Sets the TrustManagerFactory used to validate peer TLS certificates during the QUIC handshake.

Parameters:

trustManager - the trust manager factory to use

Returns:

this builder instance for method chaining

setTrustManager

public QUICBabelChannelBuilder setTrustManager(TrustManager trustManager)

Sets the TrustManager used to validate peer TLS certificates during the QUIC handshake.

Parameters:

trustManager - the trust manager to use

Returns:

this builder instance for method chaining

setKeyMaterial

public QUICBabelChannelBuilder setKeyMaterial(CertGenerator.KeyMaterial keyMaterial)

Sets pre-generated CertGenerator.KeyMaterial containing the ephemeral key and certificate.

Parameters:

keyMaterial - the key material to use

Returns:

this builder instance for method chaining

setComparator

public QUICBabelChannelBuilder setComparator(Comparator<? extends BabelNode> comparator)

Sets the comparator used to resolve simultaneous-connection conflicts.

Parameters:

comparator - the comparator to use for tie-breaking

Returns:

this builder instance for method chaining

build

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

Builds the channel or returns a protocol-specific wrapper if the underlying channel has already been constructed.

Parameters:

runtime - the Babel runtime instance

store - the node store containing peer components

identity - the local node's identity

protocol - the Babel protocol registering with the channel

Returns:

a BabelChannel wrapper bound to the registering protocol

Throws:

IllegalArgumentException - if numberOfStreams has not been set (equals 0)