Modifier and Type	Class and Description
pack-priv static class	TransportConfig.TransportChannelInitializer

Modifier and Type	Field and Description
pack-priv Map<AttributeKey<?>, ?>	attrs
pack-priv Supplier<? extends SocketAddress>	bindAddress
pack-priv ChannelGroup	channelGroup
pack-priv ChannelPipelineConfigurer	doOnChannelInit
pack-priv static final Logger	log
pack-priv LoggingHandler	loggingHandler
pack-priv LoopResources	loopResources
pack-priv ChannelMetricsRecorder	metricsRecorder
pack-priv ConnectionObserver	observer
pack-priv Map<ChannelOption<?>, ?>	options
pack-priv boolean	preferNative

Access	Constructor and 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 and Description
public final Map<AttributeKey<?>, ?>	Returns: the read-only default channel attributes attributes() Return the read-only default channel attributes.
public final Supplier<? extends SocketAddress>	Returns: the `SocketAddress` supplier bindAddress() Return the local `SocketAddress` supplier that will be bound or null.
public final ChannelGroup	Returns: the configured `ChannelGroup` or null channelGroup() Return the configured `ChannelGroup` or null.
public int	channelHash()
public final ChannelInitializer<Channel>	Returns: the `ChannelInitializer` that will be used for initializing the channel pipeline channelInitializer(ConnectionObserver the configured `ConnectionObserver` connectionObserver, SocketAddress the remote address remoteAddress, boolean channel initializer for the server or for the client onServer) Return the `ChannelInitializer` that will be used for initializing the channel pipeline.
public ChannelOperations.OnSetup	Returns: the associated `ChannelOperations.OnSetup` channelOperationsProvider() Return the associated `ChannelOperations.OnSetup`, config implementations might override this.
protected abstract Class<? extends Channel>	Returns: the channel type this configuration is associated with channelType(boolean true if `io.netty.channel.unix.DomainSocketChannel` or `io.netty.channel.unix.ServerDomainSocketChannel` is needed, false otherwise isDomainSocket) Return the channel type this configuration is associated with, it can be one of the following.
protected ChannelFactory<? extends Channel>	Returns: the `ChannelFactory` which is used to create `Channel` instances. connectionFactory(EventLoopGroup the `EventLoopGroup` elg, boolean true if `io.netty.channel.unix.DomainSocketChannel` or `io.netty.channel.unix.ServerDomainSocketChannel` is needed, false otherwise isDomainSocket) Deprecated as a consequence of `ChannelFactory` being deprecated. Return the `ChannelFactory` which is used to create `Channel` instances.
public final ConnectionObserver	Returns: the configured `ConnectionObserver` if any or `ConnectionObserver#emptyListener()` connectionObserver() Return the configured `ConnectionObserver` if any or `ConnectionObserver#emptyListener()`.
protected abstract ConnectionObserver	Returns: the configured default `ConnectionObserver` defaultConnectionObserver() Return the configured default `ConnectionObserver`.
protected abstract LoggingHandler	Returns: the default `LoggingHandler` to wiretap this transport defaultLoggingHandler() Return the default `LoggingHandler` to wiretap this transport.
protected abstract LoopResources	Returns: the default `LoopResources` for this transport defaultLoopResources() Return the default `LoopResources` for this transport.
protected abstract ChannelMetricsRecorder	Returns: the configured metrics recorder defaultMetricsRecorder() Return the configured metrics recorder.
protected abstract ChannelPipelineConfigurer	Returns: the default callback if any or `ChannelPipelineConfigurer#emptyConfigurer()` defaultOnChannelInit() Return the default callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`.
public final ChannelPipelineConfigurer	Returns: the configured callback if any or `ChannelPipelineConfigurer#emptyConfigurer()` doOnChannelInit() Return the configured callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`.
protected abstract EventLoopGroup	Returns: the configured `EventLoopGroup` eventLoopGroup() Return the configured `EventLoopGroup`.
public final boolean	Returns: `true` if prefer native event loop and channel factory (e.g. epoll or kqueue) isPreferNative() Return `true` if prefer native event loop and channel factory (e.g. epoll or kqueue).
public final LoggingHandler	Returns: the configured `LoggingHandler` or null loggingHandler() Return the configured `LoggingHandler` or null.
protected void	loggingHandler(LoggingHandler loggingHandler)
public final LoopResources	Returns: the configured `LoopResources` or the default loopResources() Return the configured `LoopResources` or the default.
public final Supplier<? extends ChannelMetricsRecorder>	Returns: the configured metrics recorder `ChannelMetricsRecorder` or null metricsRecorder() Return the configured metrics recorder `ChannelMetricsRecorder` or null.
protected void	metricsRecorder(Supplier<? extends ChannelMetricsRecorder> a supplier for the `ChannelMetricsRecorder` metricsRecorderSupplier) Obtains immediately the `ChannelMetricsRecorder` from the provided `Supplier`.
protected ChannelMetricsRecorder	metricsRecorderInternal()
public final Map<ChannelOption<?>, ?>	Returns: the read-only `ChannelOption` map options() Return the read-only `ChannelOption` map.
protected static < key type to add K, value to add V> Map<K, V>	Returns: a new instance of the map updateMap(Map<K, V> the container map to update parentMap, Object the key to update key, Object the new value or null to remove an existing key value) Add or remove values to a map in an immutable way by returning a new map instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attrs	back to summary
pack-priv Map<AttributeKey<?>, ?> attrs

bindAddress	back to summary
pack-priv Supplier<? extends SocketAddress> bindAddress

channelGroup	back to summary
pack-priv ChannelGroup channelGroup

doOnChannelInit	back to summary
pack-priv ChannelPipelineConfigurer doOnChannelInit

log	back to summary
pack-priv static final Logger log

loggingHandler	back to summary
pack-priv LoggingHandler loggingHandler

loopResources	back to summary
pack-priv LoopResources loopResources

metricsRecorder	back to summary
pack-priv ChannelMetricsRecorder metricsRecorder

observer	back to summary
pack-priv ConnectionObserver observer

options	back to summary
pack-priv Map<ChannelOption<?>, ?> options

preferNative	back to summary
pack-priv boolean preferNative

Constructor Detail

TransportConfig	back to summary
protected TransportConfig(Map<ChannelOption<?>, ?> options) Default TransportConfig with options.

TransportConfig	back to summary
protected TransportConfig(Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> bindAddress) Default TransportConfig with options.

TransportConfig	back to summary
protected TransportConfig(TransportConfig parent) Create TransportConfig from an existing one.

Method Detail

attributes	back to summary
public final Map<AttributeKey<?>, ?> attributes() Return the read-only default channel attributes. Returns:Map<AttributeKey<?>, ?> the read-only default channel attributes

attributes

back to summary

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

Return the read-only default channel attributes.

Returns:Map<AttributeKey<?>, ?>: the read-only default channel attributes

bindAddress back to summary

bindAddress	back to summary
public final Supplier<? extends SocketAddress> bindAddress() Return the local `SocketAddress` supplier that will be bound or null. Returns:Supplier<? extends SocketAddress> the `SocketAddress` supplier Annotations @Nullable

public final Supplier<? extends SocketAddress> bindAddress()

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

Returns:Supplier<? extends SocketAddress>

the SocketAddress supplier

Annotations

@Nullable

channelGroup back to summary

channelGroup	back to summary
public final ChannelGroup channelGroup() Return the configured `ChannelGroup` or null. Returns:ChannelGroup the configured `ChannelGroup` or null Annotations @Nullable

public final ChannelGroup channelGroup()

Return the configured ChannelGroup or null.

Returns:ChannelGroup

the configured ChannelGroup or null

Annotations

@Nullable

channelHash	back to summary
public int channelHash()

channelInitializer back to summary

channelInitializer	back to summary
public final ChannelInitializer<Channel> channelInitializer(ConnectionObserver connectionObserver, SocketAddress remoteAddress, boolean onServer) Return the `ChannelInitializer` that will be used for initializing the channel pipeline. Parameters connectionObserver:ConnectionObserver the configured `ConnectionObserver` remoteAddress:SocketAddress the remote address onServer:boolean channel initializer for the server or for the client Returns:ChannelInitializer<Channel> the `ChannelInitializer` that will be used for initializing the channel pipeline

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

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

Parameters

connectionObserver:ConnectionObserver: the configured ConnectionObserver
remoteAddress:SocketAddress: the remote address
onServer:boolean: channel initializer for the server or for the client

Returns:ChannelInitializer<Channel>

the ChannelInitializer that will be used for initializing the channel pipeline

channelOperationsProvider back to summary

channelOperationsProvider	back to summary
public ChannelOperations.OnSetup channelOperationsProvider() Return the associated `ChannelOperations.OnSetup`, config implementations might override this. Returns:ChannelOperations.OnSetup the associated `ChannelOperations.OnSetup`

public ChannelOperations.OnSetup channelOperationsProvider()

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

Returns:ChannelOperations.OnSetup: the associated ChannelOperations.OnSetup

channelType back to summary

channelType	back to summary
protected abstract Class<? extends Channel> channelType(boolean isDomainSocket) Return the channel type this configuration is associated with, it can be one of the following. `io.netty.channel.socket.SocketChannel` `io.netty.channel.socket.ServerSocketChannel` `io.netty.channel.unix.DomainSocketChannel` `io.netty.channel.unix.ServerDomainSocketChannel` `io.netty.channel.socket.DatagramChannel` Parameters isDomainSocket:boolean true if `io.netty.channel.unix.DomainSocketChannel` or `io.netty.channel.unix.ServerDomainSocketChannel` is needed, false otherwise Returns:Class<? extends Channel> the channel type this configuration is associated with

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

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

Parameters

isDomainSocket:boolean: true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise

Returns:Class<? extends Channel>

the channel type this configuration is associated with

connectionFactory back to summary

connectionFactory	back to summary
protected ChannelFactory<? extends Channel> connectionFactory(EventLoopGroup elg, boolean isDomainSocket) Deprecated as a consequence of `ChannelFactory` being deprecated. See corresponding docs for further information. Return the `ChannelFactory` which is used to create `Channel` instances. Parameters elg:EventLoopGroup the `EventLoopGroup` isDomainSocket:boolean true if `io.netty.channel.unix.DomainSocketChannel` or `io.netty.channel.unix.ServerDomainSocketChannel` is needed, false otherwise Returns:ChannelFactory<? extends Channel> the `ChannelFactory` which is used to create `Channel` instances.

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

Deprecated

as a consequence of ChannelFactory being deprecated. See corresponding docs for further information.

Return the ChannelFactory which is used to create Channel instances.

Parameters

elg:EventLoopGroup: the EventLoopGroup
isDomainSocket:boolean: true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise

Returns:ChannelFactory<? extends Channel>

the ChannelFactory which is used to create Channel instances.

connectionObserver back to summary

connectionObserver	back to summary
public final ConnectionObserver connectionObserver() Return the configured `ConnectionObserver` if any or `ConnectionObserver#emptyListener()`. Returns:ConnectionObserver the configured `ConnectionObserver` if any or `ConnectionObserver#emptyListener()`

public final ConnectionObserver connectionObserver()

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

Returns:ConnectionObserver: the configured ConnectionObserver if any or ConnectionObserver#emptyListener()

defaultConnectionObserver back to summary

defaultConnectionObserver	back to summary
protected abstract ConnectionObserver defaultConnectionObserver() Return the configured default `ConnectionObserver`. Returns:ConnectionObserver the configured default `ConnectionObserver`

protected abstract ConnectionObserver defaultConnectionObserver()

Return the configured default ConnectionObserver.

Returns:ConnectionObserver: the configured default ConnectionObserver

defaultLoggingHandler back to summary

defaultLoggingHandler	back to summary
protected abstract LoggingHandler defaultLoggingHandler() Return the default `LoggingHandler` to wiretap this transport. Returns:LoggingHandler the default `LoggingHandler` to wiretap this transport

protected abstract LoggingHandler defaultLoggingHandler()

Return the default LoggingHandler to wiretap this transport.

Returns:LoggingHandler: the default LoggingHandler to wiretap this transport

defaultLoopResources back to summary

defaultLoopResources	back to summary
protected abstract LoopResources defaultLoopResources() Return the default `LoopResources` for this transport. Returns:LoopResources the default `LoopResources` for this transport

protected abstract LoopResources defaultLoopResources()

Return the default LoopResources for this transport.

Returns:LoopResources: the default LoopResources for this transport

defaultMetricsRecorder	back to summary
protected abstract ChannelMetricsRecorder defaultMetricsRecorder() Return the configured metrics recorder. Returns:ChannelMetricsRecorder the configured metrics recorder

defaultMetricsRecorder

back to summary

protected abstract ChannelMetricsRecorder defaultMetricsRecorder()

Return the configured metrics recorder.

Returns:ChannelMetricsRecorder: the configured metrics recorder

defaultOnChannelInit back to summary

defaultOnChannelInit	back to summary
protected abstract ChannelPipelineConfigurer defaultOnChannelInit() Return the default callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`. Returns:ChannelPipelineConfigurer the default callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`

protected abstract ChannelPipelineConfigurer defaultOnChannelInit()

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

Returns:ChannelPipelineConfigurer: the default callback if any or ChannelPipelineConfigurer#emptyConfigurer()

doOnChannelInit back to summary

doOnChannelInit	back to summary
public final ChannelPipelineConfigurer doOnChannelInit() Return the configured callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`. Returns:ChannelPipelineConfigurer the configured callback if any or `ChannelPipelineConfigurer#emptyConfigurer()`

public final ChannelPipelineConfigurer doOnChannelInit()

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

Returns:ChannelPipelineConfigurer: the configured callback if any or ChannelPipelineConfigurer#emptyConfigurer()

eventLoopGroup back to summary

eventLoopGroup	back to summary
protected abstract EventLoopGroup eventLoopGroup() Return the configured `EventLoopGroup`. Returns:EventLoopGroup the configured `EventLoopGroup`

protected abstract EventLoopGroup eventLoopGroup()

Return the configured EventLoopGroup.

Returns:EventLoopGroup: the configured EventLoopGroup

isPreferNative back to summary

isPreferNative	back to summary
public final boolean isPreferNative() Return `true` if prefer native event loop and channel factory (e.g. epoll or kqueue). Returns:boolean `true` if prefer native event loop and channel factory (e.g. epoll or kqueue)

public final boolean isPreferNative()

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

Returns:boolean: true if prefer native event loop and channel factory (e.g. epoll or kqueue)

loggingHandler back to summary

loggingHandler	back to summary
public final LoggingHandler loggingHandler() Return the configured `LoggingHandler` or null. Returns:LoggingHandler the configured `LoggingHandler` or null Annotations @Nullable

public final LoggingHandler loggingHandler()

Return the configured LoggingHandler or null.

Returns:LoggingHandler

the configured LoggingHandler or null

Annotations

@Nullable

loggingHandler	back to summary
protected void loggingHandler(LoggingHandler loggingHandler)

loopResources back to summary

loopResources	back to summary
public final LoopResources loopResources() Return the configured `LoopResources` or the default. Returns:LoopResources the configured `LoopResources` or the default

public final LoopResources loopResources()

Return the configured LoopResources or the default.

Returns:LoopResources: the configured LoopResources or the default

metricsRecorder back to summary

metricsRecorder	back to summary
public final Supplier<? extends ChannelMetricsRecorder> metricsRecorder() Return the configured metrics recorder `ChannelMetricsRecorder` or null. Returns:Supplier<? extends ChannelMetricsRecorder> the configured metrics recorder `ChannelMetricsRecorder` or null Annotations @Nullable

public final Supplier<? extends ChannelMetricsRecorder> metricsRecorder()

Return the configured metrics recorder ChannelMetricsRecorder or null.

Returns:Supplier<? extends ChannelMetricsRecorder>

the configured metrics recorder ChannelMetricsRecorder or null

Annotations

@Nullable

metricsRecorder back to summary

metricsRecorder	back to summary
protected void metricsRecorder(Supplier<? extends ChannelMetricsRecorder> metricsRecorderSupplier) Obtains immediately the `ChannelMetricsRecorder` from the provided `Supplier`. Parameters metricsRecorderSupplier:Supplier<? extends ChannelMetricsRecorder> a supplier for the `ChannelMetricsRecorder`

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

Obtains immediately the ChannelMetricsRecorder from the provided Supplier.

Parameters

metricsRecorderSupplier:Supplier<? extends ChannelMetricsRecorder>: a supplier for the ChannelMetricsRecorder

metricsRecorderInternal	back to summary
protected ChannelMetricsRecorder metricsRecorderInternal()

options back to summary

options	back to summary
public final Map<ChannelOption<?>, ?> options() Return the read-only `ChannelOption` map. Returns:Map<ChannelOption<?>, ?> the read-only `ChannelOption` map

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

Return the read-only ChannelOption map.

Returns:Map<ChannelOption<?>, ?>: the read-only ChannelOption map

updateMap	back to summary
protected static <K, V> Map<K, V> updateMap(Map<K, V> parentMap, Object key, Object value) Add or remove values to a map in an immutable way by returning a new map instance. Parameters <K> key type to add <V> value to add parentMap:Map<K, V> the container map to update key:Object the key to update value:Object the new value or null to remove an existing key Returns:Map<K, V> a new instance of the map Annotations @SuppressWarnings:unchecked

updateMap

back to summary

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

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

Parameters

<K>: key type to add
<V>: value to add
parentMap:Map<K, V>: the container map to update
key:Object: the key to update
value:Object: the new value or null to remove an existing key

Returns:Map<K, V>

a new instance of the map

Annotations

@SuppressWarnings:unchecked

reactor.netty.transport back to summary

pack-priv final Class TransportConfig.TransportChannelInitializer

Class Inheritance

extends ChannelInitializer<Channel>

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.channel.ChannelInitializer
reactor.netty.transport.TransportConfig.TransportChannelInitializer

Field Summary

Modifier and Type	Field and Description
pack-priv final TransportConfig	config
pack-priv final ConnectionObserver	connectionObserver
pack-priv final boolean	onServer
pack-priv final SocketAddress	remoteAddress

Constructor Summary

Access	Constructor and Description
pack-priv	TransportChannelInitializer(TransportConfig config, ConnectionObserver connectionObserver, SocketAddress remoteAddress, boolean onServer)

Method Summary

Modifier and Type	Method and Description
protected void	initChannel(Channel the `Channel` which was registered. channel) Implements abstract io.netty.channel.ChannelInitializer.initChannel. This method will be called once the `Channel` was registered.

Inherited from io.netty.channel.ChannelInitializer:: channelRegistered exceptionCaught handlerAdded handlerRemoved

Field Detail

config	back to summary
pack-priv final TransportConfig config

connectionObserver	back to summary
pack-priv final ConnectionObserver connectionObserver

onServer	back to summary
pack-priv final boolean onServer

remoteAddress	back to summary
pack-priv final SocketAddress remoteAddress

Constructor Detail

TransportChannelInitializer	back to summary
pack-priv TransportChannelInitializer(TransportConfig config, ConnectionObserver connectionObserver, SocketAddress remoteAddress, boolean onServer)

Method Detail

initChannel back to summary

protected void initChannel(Channel channel)

Implements abstract io.netty.channel.ChannelInitializer.initChannel.

Doc from io.netty.channel.ChannelInitializer.initChannel.

This method will be called once the Channel was registered. After the method returns this instance will be removed from the ChannelPipeline of the Channel.

Parameters

channel:Channel: the Channel which was registered.

Annotations

@Override

public abstract Class TransportConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class TransportConfig.TransportChannelInitializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail