Top Description Inners Fields Constructors Methods
reactor.netty5.transport

public abstract Class ClientTransportConfig<CONF extends reactor.netty5.transport.TransportConfig>

extends TransportConfig
Class Inheritance
Known Direct Subclasses
reactor.netty5.udp.UdpClientConfig, reactor.netty5.tcp.TcpClientConfig
Type Parameters
<CONF>
Configuration implementation
Imports
java.net.ProtocolFamily, .SocketAddress, java.util.Map, .Objects, java.util.concurrent.ConcurrentHashMap, .ConcurrentMap, java.util.function.BiConsumer, .Consumer, .Supplier, io.netty5.channel.Channel, .ChannelOption, .EventLoopGroup, .ServerChannel, .ServerChannelFactory, io.netty5.channel.group.ChannelGroup, io.netty5.resolver.AddressResolverGroup, io.netty5.resolver.dns.DnsAddressResolverGroup, reactor.netty5.ChannelPipelineConfigurer, .Connection, .ConnectionObserver, reactor.netty5.channel.MicrometerChannelMetricsRecorder, reactor.netty5.resources.ConnectionProvider, .LoopResources, reactor.netty5.internal.util.MapUtils, reactor.util.annotation.Nullable

Encapsulate all necessary configuration for client transport. The public API is read-only.
Authors
Stephane Maldini, Violeta Georgieva
Since
1.0.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv final ConnectionProvider
pack-priv static final NameResolverProvider
pack-priv BiConsumer<? super Connection, ? super SocketAddress>
pack-priv Consumer<? super CONF>
pack-priv Consumer<? super Connection>
pack-priv Consumer<? super Connection>
pack-priv Consumer<? super Connection>
pack-priv BiConsumer<? super Connection, ? super Throwable>
pack-priv NameResolverProvider
pack-priv ProxyProvider
pack-priv Supplier<? extends SocketAddress>
pack-priv AddressResolverGroup<?>
pack-priv static final ConcurrentMap<Integer, DnsAddressResolverGroup>
Inherited from reactor.netty5.transport.TransportConfig:
attrsbindAddresschannelGroupdoOnChannelInitfamilylogloggingHandlerloopResourcesmetricsRecorderobserveroptionspreferNative

Constructor Summary

AccessConstructor and Description
protected
ClientTransportConfig(ConnectionProvider connectionProvider, Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> remoteAddress)

protected

Method Summary

Modifier and TypeMethod and Description
public int
public ConnectionProvider
protected abstract AddressResolverGroup<?>

Returns:

the global AddressResolverGroup
defaultAddressResolverGroup
()

Provides a global AddressResolverGroup that is shared amongst all clients.

protected ConnectionObserver
protected ChannelPipelineConfigurer
public final Consumer<? super CONF>

Returns:

the configured callback or null
doOnConnect
()

Return the configured callback or null

public final Consumer<? super Connection>

Returns:

the configured callback or null
doOnConnected
()

Return the configured callback or null

public final Consumer<? super Connection>

Returns:

the configured callback or null
doOnDisconnected
()

Return the configured callback or null

protected EventLoopGroup
public NameResolverProvider

Returns:

the configured NameResolverProvider or null
getNameResolverProvider
()

Return the configured NameResolverProvider or null

pack-priv static DnsAddressResolverGroup
getOrCreateResolver(NameResolverProvider nameResolverProvider, LoopResources loopResources, boolean preferNative)

public final boolean

Returns:

true if that ClientTransportConfig is configured with a proxy
hasProxy
()

Return true if that ClientTransportConfig is configured with a proxy

public final ProxyProvider

Returns:

the ProxyProvider if any or null
proxyProvider
()

Return the ProxyProvider if any or null

protected void
public final Supplier<? extends SocketAddress>

Returns:

the remote configured SocketAddress
remoteAddress
()

Return the remote configured SocketAddress

public final AddressResolverGroup<?>

Returns:

the configured AddressResolverGroup or null
resolver
()

Return the configured AddressResolverGroup or null.

protected AddressResolverGroup<?>
protected Class<? extends ServerChannel>
serverChannelType()

Overrides reactor.netty5.transport.TransportConfig.serverChannelType.

Return the channel type this configuration is associated with, it can be one of the following:
protected ServerChannelFactory<? extends ServerChannel>
serverConnectionFactory(ProtocolFamily
the configured ProtocolFamily to run with
protocolFamily
)

Overrides reactor.netty5.transport.TransportConfig.serverConnectionFactory.

Return the ServerChannelFactory which is used to create ServerChannel instances.
Inherited from reactor.netty5.transport.TransportConfig:
attributesbindAddresschannelGroupchannelInitializerchannelOperationsProviderchannelTypeconnectionFactoryconnectionObserverdefaultLoggingHandlerdefaultLoopResourcesdefaultMetricsRecorderdoOnChannelInitfamilyisPreferNativeloggingHandlerloggingHandlerloopResourcesmetricsRecordermetricsRecordermetricsRecorderInternaloptionsupdateMap

Field Detail

connectionProviderback to summary
pack-priv final ConnectionProvider connectionProvider
DEFAULT_NAME_RESOLVER_PROVIDERback to summary
pack-priv static final NameResolverProvider DEFAULT_NAME_RESOLVER_PROVIDER
doAfterResolveback to summary
pack-priv BiConsumer<? super Connection, ? super SocketAddress> doAfterResolve
doOnConnectback to summary
pack-priv Consumer<? super CONF> doOnConnect
doOnConnectedback to summary
pack-priv Consumer<? super Connection> doOnConnected
doOnDisconnectedback to summary
pack-priv Consumer<? super Connection> doOnDisconnected
doOnResolveback to summary
pack-priv Consumer<? super Connection> doOnResolve
doOnResolveErrorback to summary
pack-priv BiConsumer<? super Connection, ? super Throwable> doOnResolveError
nameResolverProviderback to summary
pack-priv NameResolverProvider nameResolverProvider
proxyProviderback to summary
pack-priv ProxyProvider proxyProvider
remoteAddressback to summary
pack-priv Supplier<? extends SocketAddress> remoteAddress
resolverback to summary
pack-priv AddressResolverGroup<?> resolver
RESOLVERS_CACHEback to summary
pack-priv static final ConcurrentMap<Integer, DnsAddressResolverGroup> RESOLVERS_CACHE

Constructor Detail

ClientTransportConfigback to summary
protected ClientTransportConfig(ConnectionProvider connectionProvider, Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> remoteAddress)
ClientTransportConfigback to summary
protected ClientTransportConfig(ClientTransportConfig<CONF> parent)

Method Detail

channelHashback to summary
public int channelHash()

Overrides reactor.netty5.transport.TransportConfig.channelHash.

Annotations
@Override
connectionProviderback to summary
public ConnectionProvider connectionProvider()

Return the ConnectionProvider

Returns:ConnectionProvider

the ConnectionProvider

defaultAddressResolverGroupback to summary
protected abstract AddressResolverGroup<?> defaultAddressResolverGroup()

Provides a global AddressResolverGroup that is shared amongst all clients.

Returns:AddressResolverGroup<?>

the global AddressResolverGroup

defaultConnectionObserverback to summary
protected ConnectionObserver defaultConnectionObserver()

Implements abstract reactor.netty5.transport.TransportConfig.defaultConnectionObserver.

Doc from reactor.netty5.transport.TransportConfig.defaultConnectionObserver.

Return the configured default ConnectionObserver.

Returns:ConnectionObserver

the configured default ConnectionObserver

Annotations
@Override
defaultOnChannelInitback to summary
protected ChannelPipelineConfigurer defaultOnChannelInit()

Implements abstract reactor.netty5.transport.TransportConfig.defaultOnChannelInit.

Doc from reactor.netty5.transport.TransportConfig.defaultOnChannelInit.

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

Returns:ChannelPipelineConfigurer

the default callback if any or ChannelPipelineConfigurer#emptyConfigurer()

Annotations
@Override
doOnConnectback to summary
public final Consumer<? super CONF> doOnConnect()

Return the configured callback or null

Returns:Consumer<? super CONF>

the configured callback or null

Annotations
@Nullable
doOnConnectedback to summary
public final Consumer<? super Connection> doOnConnected()

Return the configured callback or null

Returns:Consumer<? super Connection>

the configured callback or null

Annotations
@Nullable
doOnDisconnectedback to summary
public final Consumer<? super Connection> doOnDisconnected()

Return the configured callback or null

Returns:Consumer<? super Connection>

the configured callback or null

Annotations
@Nullable
eventLoopGroupback to summary
protected EventLoopGroup eventLoopGroup()

Implements abstract reactor.netty5.transport.TransportConfig.eventLoopGroup.

Doc from reactor.netty5.transport.TransportConfig.eventLoopGroup.

Return the configured EventLoopGroup.

Returns:EventLoopGroup

the configured EventLoopGroup

Annotations
@Override
getNameResolverProviderback to summary
public NameResolverProvider getNameResolverProvider()

Return the configured NameResolverProvider or null

Returns:NameResolverProvider

the configured NameResolverProvider or null

Annotations
@Nullable
getOrCreateResolverback to summary
pack-priv static DnsAddressResolverGroup getOrCreateResolver(NameResolverProvider nameResolverProvider, LoopResources loopResources, boolean preferNative)
hasProxyback to summary
public final boolean hasProxy()

Return true if that ClientTransportConfig is configured with a proxy

Returns:boolean

true if that ClientTransportConfig is configured with a proxy

proxyProviderback to summary
public final ProxyProvider proxyProvider()

Return the ProxyProvider if any or null

Returns:ProxyProvider

the ProxyProvider if any or null

Annotations
@Nullable
proxyProviderback to summary
protected void proxyProvider(ProxyProvider proxyProvider)
remoteAddressback to summary
public final Supplier<? extends SocketAddress> remoteAddress()

Return the remote configured SocketAddress

Returns:Supplier<? extends SocketAddress>

the remote configured SocketAddress

resolverback to summary
public final AddressResolverGroup<?> resolver()

Return the configured AddressResolverGroup or null. If there is no AddressResolverGroup configured, the default will be used.

Returns:AddressResolverGroup<?>

the configured AddressResolverGroup or null

Annotations
@Nullable
resolverInternalback to summary
protected AddressResolverGroup<?> resolverInternal()
serverChannelTypeback to summary
protected Class<? extends ServerChannel> serverChannelType()

Overrides reactor.netty5.transport.TransportConfig.serverChannelType.

Doc from reactor.netty5.transport.TransportConfig.serverChannelType.

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

Returns:Class<? extends ServerChannel>

the channel type this configuration is associated with

Annotations
@Override
serverConnectionFactoryback to summary
protected ServerChannelFactory<? extends ServerChannel> serverConnectionFactory(ProtocolFamily protocolFamily)

Overrides reactor.netty5.transport.TransportConfig.serverConnectionFactory.

Doc from reactor.netty5.transport.TransportConfig.serverConnectionFactory.

Return the ServerChannelFactory which is used to create ServerChannel instances.

Parameters
protocolFamily:ProtocolFamily

the configured ProtocolFamily to run with

Returns:ServerChannelFactory<? extends ServerChannel>

the ServerChannelFactory which is used to create ServerChannel instances.

Annotations
@Override
reactor.netty5.transport back to summary

pack-priv final Class ClientTransportConfig.ClientTransportChannelInitializer

extends Object
implements ChannelPipelineConfigurer
Class Inheritance
  • java.lang.Object
  • reactor.netty5.transport.ClientTransportConfig.ClientTransportChannelInitializer
All Implemented Interfaces
reactor.netty5.ChannelPipelineConfigurer

Field Summary

Modifier and TypeField and Description
pack-priv final ProxyProvider

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
onChannelInit(ConnectionObserver
the configured ConnectionObserver
connectionObserver
,
Channel
the channel
channel
,
SocketAddress
the remote address
remoteAddress
)

Implements reactor.netty5.ChannelPipelineConfigurer.onChannelInit.

Configure the channel pipeline while initializing the channel.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

proxyProviderback to summary
pack-priv final ProxyProvider proxyProvider

Constructor Detail

ClientTransportChannelInitializerback to summary
pack-priv ClientTransportChannelInitializer(ProxyProvider proxyProvider)

Method Detail

onChannelInitback to summary
public void onChannelInit(ConnectionObserver connectionObserver, Channel channel, SocketAddress remoteAddress)

Implements reactor.netty5.ChannelPipelineConfigurer.onChannelInit.

Doc from reactor.netty5.ChannelPipelineConfigurer.onChannelInit.

Configure the channel pipeline while initializing the channel.

Parameters
connectionObserver:ConnectionObserver

the configured ConnectionObserver

channel:Channel

the channel

remoteAddress:SocketAddress

the remote address

Annotations
@Override
reactor.netty5.transport back to summary

pack-priv final Class ClientTransportConfig.ClientTransportDoOn

extends Object
implements ConnectionObserver
Class Inheritance
  • java.lang.Object
  • reactor.netty5.transport.ClientTransportConfig.ClientTransportDoOn
All Implemented Interfaces
reactor.netty5.ConnectionObserver

Field Summary

Modifier and TypeField and Description
pack-priv final ChannelGroup
pack-priv final Consumer<? super Connection>
pack-priv final Consumer<? super Connection>

Constructor Summary

AccessConstructor and Description
pack-priv
ClientTransportDoOn(ChannelGroup channelGroup, Consumer<? super Connection> doOnConnected, Consumer<? super Connection> doOnDisconnected)

Method Summary

Modifier and TypeMethod and Description
public void
onStateChange(Connection
the connection reference
connection
,
ConnectionObserver.State
the new State
newState
)

Implements reactor.netty5.ConnectionObserver.onStateChange.

React on connection state change (e.g. http request or response)
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

channelGroupback to summary
pack-priv final ChannelGroup channelGroup
doOnConnectedback to summary
pack-priv final Consumer<? super Connection> doOnConnected
doOnDisconnectedback to summary
pack-priv final Consumer<? super Connection> doOnDisconnected

Constructor Detail

ClientTransportDoOnback to summary
pack-priv ClientTransportDoOn(ChannelGroup channelGroup, Consumer<? super Connection> doOnConnected, Consumer<? super Connection> doOnDisconnected)

Method Detail

onStateChangeback to summary
public void onStateChange(Connection connection, ConnectionObserver.State newState)

Implements reactor.netty5.ConnectionObserver.onStateChange.

Doc from reactor.netty5.ConnectionObserver.onStateChange.

React on connection state change (e.g. http request or response)

Parameters
connection:Connection

the connection reference

newState:ConnectionObserver.State

the new State

Annotations
@Override