Class TCPBabelChannel

java.lang.Object

pt.unl.fct.di.novasys.babel2.channels.tcp_tls.AbstractTCPBabelChannel

pt.unl.fct.di.novasys.babel2.channels.tcp_tls.TCPBabelChannel

All Implemented Interfaces:

BabelChannel, IPBabelChannel

public final class TCPBabelChannel
extends AbstractTCPBabelChannel

Concrete TCP Babel channel implementation that transports messages over persistent TCP connections.

Configures Netty's ServerSocketChannel and client Bootstrap pipelines with length-field framing and handshake codecs.

Instances of this channel should be created via builder().

Nested Class Summary

Nested classes/interfaces inherited from class AbstractTCPBabelChannel

AbstractTCPBabelChannel.TCPBabelChannelAuthMode

Modifier and Type	Class	Description
static enum	AbstractTCPBabelChannel.TCPBabelChannelAuthMode	Modes used to describe which types of signed messages are allowed on the channel.

Field Summary

Fields inherited from class AbstractTCPBabelChannel

DEFAULT_CONNECTION_UP_DELAY, DEFAULT_CONNECTION_UP_DELAY_UNIT, EXPECTED_PEER, HANDSHAKE_CODEC_NAME, HANDSHAKE_HANDLER_NAME

Modifier and Type	Field	Description
static final long	DEFAULT_CONNECTION_UP_DELAY	Default delay before delivering a connection up event to allow state settling.
static final TimeUnit	DEFAULT_CONNECTION_UP_DELAY_UNIT	Default time unit for AbstractTCPBabelChannel.DEFAULT_CONNECTION_UP_DELAY.
static final io.netty.util.AttributeKey<BabelNode>	EXPECTED_PEER	Netty channel attribute key storing the expected remote peer node identity for outbound connections.
static final String	HANDSHAKE_CODEC_NAME	Name of the handshake codec handler in the Netty pipeline.
static final String	HANDSHAKE_HANDLER_NAME	Name of the handshake handler in the Netty pipeline.

Method Summary

Modifier and Type	Method	Description
static TCPBabelChannelBuilder	builder()	Creates a new TCPBabelChannelBuilder instance for configuring a TCPBabelChannel.
protected io.netty.bootstrap.Bootstrap	createClientBootstrap(Babel runtime, NodeStore store, io.netty.channel.EventLoopGroup workerGroup, int numberOfMessages, boolean verifyIdentity, AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode, @Nullable Set<BabelNode> permittedNodes)	Creates and configures the Netty client Bootstrap for initiating outbound connections.
protected io.netty.channel.socket.ServerSocketChannel	createServerSocketChannel(Babel runtime, NodeStore store, InetSocketAddress address, io.netty.channel.EventLoopGroup workerGroup, int numberOfMessages, boolean verifyIdentity, AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode, @Nullable Set<BabelNode> permittedNodes)	Creates and binds the Netty ServerSocketChannel for accepting incoming connections.

Methods inherited from class AbstractTCPBabelChannel

connect, disconnect, getBindingAddress, getPermittedNodes, init, isConnected, send, sendEphemeral, shutdown

Modifier and Type	Method	Description
void	connect(BabelNode peer)	Initiates a TCP connection to the specified peer node.
void	disconnect(BabelNode peer)	Disconnects the active TCP connection to the specified peer.
InetSocketAddress	getBindingAddress()	Returns the local socket address to which the server socket channel is bound.
@Nullable Set<BabelNode>	getPermittedNodes()	Returns the set of permitted nodes for this channel, or null if all nodes are permitted.
protected void	init(InetSocketAddress address, io.netty.channel.EventLoopGroup workerGroup, int numberOfMessages, boolean verifyIdentity, AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode)	Initializes the server channel and client bootstrap by invoking the subclass-defined channel and bootstrap factory methods using the configured permitted nodes.
boolean	isConnected(BabelNode peer)	Checks whether an active TCP connection to the specified peer exists.
void	send(BabelNode peer, BabelMessage message)	Sends a BabelMessage to the specified peer over the active TCP connection.
void	sendEphemeral(BabelNode peer, BabelMessage message)	Sends a message to peer without establishing a persistent connection.
void	shutdown()	Shuts down the TCP server channel and terminates all active peer connections.

Methods inherited from class Object

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

Methods inherited from interface BabelChannel

getInner

Modifier and Type	Method	Description
default BabelChannel	getInner()	Gets this channel or returns the inner channel if this instance is a wrapper.

Method Details

createServerSocketChannel

protected io.netty.channel.socket.ServerSocketChannel createServerSocketChannel(Babel runtime,
 NodeStore store,
 InetSocketAddress address,
 io.netty.channel.EventLoopGroup workerGroup,
 int numberOfMessages,
 boolean verifyIdentity,
 AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode,
 @Nullable Set<BabelNode> permittedNodes)

Description copied from class: AbstractTCPBabelChannel

Creates and binds the Netty ServerSocketChannel for accepting incoming connections.

Specified by:

createServerSocketChannel in class AbstractTCPBabelChannel

Parameters:

runtime - the Babel runtime

store - the node store for address and component resolution

address - the local address to bind to

workerGroup - the Netty event loop group for channel I/O

numberOfMessages - outbound message queue buffer capacity per connection

verifyIdentity - whether cryptographic identity verification is enabled

authMode - the authentication mode configuring accepted message types

permittedNodes - the set of permitted nodes, or null if all nodes are permitted

Returns:

the bound and initialized ServerSocketChannel

createClientBootstrap

protected io.netty.bootstrap.Bootstrap createClientBootstrap(Babel runtime,
 NodeStore store,
 io.netty.channel.EventLoopGroup workerGroup,
 int numberOfMessages,
 boolean verifyIdentity,
 AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode,
 @Nullable Set<BabelNode> permittedNodes)

Description copied from class: AbstractTCPBabelChannel

Creates and configures the Netty client Bootstrap for initiating outbound connections.

Specified by:

createClientBootstrap in class AbstractTCPBabelChannel

Parameters:

runtime - the Babel runtime

store - the node store for address and component resolution

workerGroup - the Netty event loop group for channel I/O

numberOfMessages - outbound message queue buffer capacity per connection

verifyIdentity - whether cryptographic identity verification is enabled

authMode - the authentication mode configuring accepted message types

permittedNodes - the set of permitted nodes, or null if all nodes are permitted

Returns:

the configured client Bootstrap

builder

public static TCPBabelChannelBuilder builder()

Creates a new TCPBabelChannelBuilder instance for configuring a TCPBabelChannel.

Returns:

a new channel builder