Package reactor.netty.transport

Class TransportConfig

java.lang.Object

reactor.netty.transport.TransportConfig

Direct Known Subclasses:

ClientTransportConfig, QuicClientConfig, QuicServerConfig, ServerTransportConfig, UdpServerConfig

public abstract class TransportConfig
extends Object

A basic configuration holder. The public API is read-only.

Since:

1.0.0

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportConfig(Map<ChannelOption<?>,?> options)	Default TransportConfig with options.
protected	TransportConfig(Map<ChannelOption<?>,?> options, Supplier<? extends SocketAddress> bindAddress)	Default TransportConfig with options.
protected	TransportConfig(TransportConfig parent)	Create TransportConfig from an existing one.

Method Summary

Modifier and Type	Method	Description
final Map<AttributeKey<?>,?>	attributes()	Return the read-only default channel attributes.
final @Nullable Supplier<? extends SocketAddress>	bindAddress()	Return the local SocketAddress supplier that will be bound or null.
protected void	bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)
final @Nullable ChannelGroup	channelGroup()	Return the configured ChannelGroup or null.
int	channelHash()
ChannelInitializer<Channel>	channelInitializer(ConnectionObserver connectionObserver, @Nullable SocketAddress remoteAddress, boolean onServer)	Return the ChannelInitializer that will be used for initializing the channel pipeline.
ChannelOperations.OnSetup	channelOperationsProvider()	Return the associated ChannelOperations.OnSetup, config implementations might override this.
protected abstract Class<? extends Channel>	channelType(boolean isDomainSocket)	Return the channel type this configuration is associated with, it can be one of the following.
protected ChannelFactory<? extends Channel>	connectionFactory(EventLoopGroup elg, boolean isDomainSocket)	Return the ChannelFactory which is used to create Channel instances.
final ConnectionObserver	connectionObserver()	Return the configured ConnectionObserver if any or ConnectionObserver.emptyListener().
protected abstract ConnectionObserver	defaultConnectionObserver()	Return the configured default ConnectionObserver.
protected abstract LoggingHandler	defaultLoggingHandler()	Return the default LoggingHandler to wiretap this transport.
protected abstract LoopResources	defaultLoopResources()	Return the default LoopResources for this transport.
protected abstract ChannelMetricsRecorder	defaultMetricsRecorder()	Return the configured metrics recorder.
protected abstract ChannelPipelineConfigurer	defaultOnChannelInit()	Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer().
final ChannelPipelineConfigurer	doOnChannelInit()	Return the configured callback if any or ChannelPipelineConfigurer.emptyConfigurer().
protected abstract EventLoopGroup	eventLoopGroup()	Return the configured EventLoopGroup.
final boolean	isPreferNative()	Return true if prefer native event loop and channel factory (e.g.
final @Nullable LoggingHandler	loggingHandler()	Return the configured LoggingHandler or null.
protected void	loggingHandler(LoggingHandler loggingHandler)
final LoopResources	loopResources()	Return the configured LoopResources or the default.
final @Nullable Supplier<? extends ChannelMetricsRecorder>	metricsRecorder()	Return the configured metrics recorder ChannelMetricsRecorder or null.
protected void	metricsRecorder(@Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorderSupplier)	Obtains immediately the ChannelMetricsRecorder from the provided Supplier.
protected @Nullable ChannelMetricsRecorder	metricsRecorderInternal()
final Map<ChannelOption<?>,?>	options()	Return the read-only ChannelOption map.
protected static <K, V> Map<K,V>	updateMap(Map<K,V> parentMap, Object key, @Nullable Object value)	Add or remove values to a map in an immutable way by returning a new map instance.

Methods inherited from class java.lang.Object

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

Constructor Details

TransportConfig

protected TransportConfig(Map<ChannelOption<?>,?> options)

Default TransportConfig with options.

TransportConfig

protected TransportConfig(Map<ChannelOption<?>,?> options,
 Supplier<? extends SocketAddress> bindAddress)

Default TransportConfig with options.

TransportConfig

protected TransportConfig(TransportConfig parent)

Create TransportConfig from an existing one.

Method Details

attributes

public final Map<AttributeKey<?>,?> attributes()

Return the read-only default channel attributes.

Returns:

the read-only default channel attributes

bindAddress

public final @Nullable Supplier<? extends SocketAddress> bindAddress()

Return the local SocketAddress supplier that will be bound or null.

Returns:

the SocketAddress supplier

channelHash

public int channelHash()

channelGroup

public final @Nullable ChannelGroup channelGroup()

Return the configured ChannelGroup or null.

Returns:

the configured ChannelGroup or null

channelInitializer

public ChannelInitializer<Channel> channelInitializer(ConnectionObserver connectionObserver,
 @Nullable SocketAddress remoteAddress,
 boolean onServer)

Return the ChannelInitializer that will be used for initializing the channel pipeline.

Parameters:

connectionObserver - the configured ConnectionObserver

remoteAddress - the remote address

onServer - channel initializer for the server or for the client

Returns:

the ChannelInitializer that will be used for initializing the channel pipeline

channelOperationsProvider

public ChannelOperations.OnSetup channelOperationsProvider()

Return the associated ChannelOperations.OnSetup, config implementations might override this.

Returns:

the associated ChannelOperations.OnSetup

connectionObserver

public final ConnectionObserver connectionObserver()

Return the configured ConnectionObserver if any or ConnectionObserver.emptyListener().

Returns:

the configured ConnectionObserver if any or ConnectionObserver.emptyListener()

doOnChannelInit

public final ChannelPipelineConfigurer doOnChannelInit()

Return the configured callback if any or ChannelPipelineConfigurer.emptyConfigurer().

Returns:

the configured callback if any or ChannelPipelineConfigurer.emptyConfigurer()

isPreferNative

public final boolean isPreferNative()

Return true if prefer native event loop and channel factory (e.g. epoll, io_uring or kqueue).

Returns:

true if prefer native event loop and channel factory (e.g. epoll, io_uring or kqueue)

loggingHandler

public final @Nullable LoggingHandler loggingHandler()

Return the configured LoggingHandler or null.

Returns:

the configured LoggingHandler or null

loopResources

public final LoopResources loopResources()

Return the configured LoopResources or the default.

Returns:

the configured LoopResources or the default

metricsRecorder

public final @Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorder()

Return the configured metrics recorder ChannelMetricsRecorder or null.

Returns:

the configured metrics recorder ChannelMetricsRecorder or null

options

public final Map<ChannelOption<?>,?> options()

Return the read-only ChannelOption map.

Returns:

the read-only ChannelOption map

bindAddress

protected void bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)

channelType

protected abstract Class<? extends Channel> channelType(boolean isDomainSocket)

Return the channel type this configuration is associated with, it can be one of the following.

• SocketChannel
• ServerSocketChannel
• DomainSocketChannel
• ServerDomainSocketChannel
• DatagramChannel

Parameters:

isDomainSocket - true if DomainSocketChannel or ServerDomainSocketChannel is needed, false otherwise

Returns:

the channel type this configuration is associated with

connectionFactory

protected ChannelFactory<? extends Channel> connectionFactory(EventLoopGroup elg,
 boolean isDomainSocket)

Return the ChannelFactory which is used to create Channel instances.

Parameters:

elg - the EventLoopGroup

isDomainSocket - true if DomainSocketChannel or ServerDomainSocketChannel is needed, false otherwise

Returns:

the ChannelFactory which is used to create Channel instances.

defaultConnectionObserver

protected abstract ConnectionObserver defaultConnectionObserver()

Return the configured default ConnectionObserver.

Returns:

the configured default ConnectionObserver

defaultLoggingHandler

protected abstract LoggingHandler defaultLoggingHandler()

Return the default LoggingHandler to wiretap this transport.

Returns:

the default LoggingHandler to wiretap this transport

defaultLoopResources

protected abstract LoopResources defaultLoopResources()

Return the default LoopResources for this transport.

Returns:

the default LoopResources for this transport

defaultMetricsRecorder

protected abstract ChannelMetricsRecorder defaultMetricsRecorder()

Return the configured metrics recorder.

Returns:

the configured metrics recorder

defaultOnChannelInit

protected abstract ChannelPipelineConfigurer defaultOnChannelInit()

Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer().

Returns:

the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()

eventLoopGroup

protected abstract EventLoopGroup eventLoopGroup()

Return the configured EventLoopGroup.

Returns:

the configured EventLoopGroup

loggingHandler

protected void loggingHandler(LoggingHandler loggingHandler)

metricsRecorder

protected void metricsRecorder(@Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorderSupplier)

Obtains immediately the ChannelMetricsRecorder from the provided Supplier.

Parameters:

metricsRecorderSupplier - a supplier for the ChannelMetricsRecorder

metricsRecorderInternal

protected @Nullable ChannelMetricsRecorder metricsRecorderInternal()

updateMap

protected static <K,
V> Map<K,V> updateMap(Map<K,V> parentMap,
 Object key,
 @Nullable Object value)

Add or remove values to a map in an immutable way by returning a new map instance.

Type Parameters:

K - key type to add

V - value to add

Parameters:

parentMap - the container map to update

key - the key to update

value - the new value or null to remove an existing key

Returns:

a new instance of the map