reactor.netty.transport

Class ClientTransportConfig<CONF extends TransportConfig>

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.transport.ClientTransportConfig<CONF>

Type Parameters:

CONF - Configuration implementation

Direct Known Subclasses:

TcpClientConfig, UdpClientConfig

public abstract class ClientTransportConfig<CONF extends TransportConfig>
extends TransportConfig

Encapsulate all necessary configuration for client transport. The public API is read-only.

Since:

1.0.0

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientTransportConfig(ClientTransportConfig<CONF> parent)
protected	ClientTransportConfig(ConnectionProvider connectionProvider, Map<ChannelOption<?>,?> options, Supplier<? extends SocketAddress> remoteAddress)

Method Summary

Modifier and Type	Method and Description
int	channelHash()
protected 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
ConnectionProvider	connectionProvider() Return the ConnectionProvider
protected abstract AddressResolverGroup<?>	defaultAddressResolverGroup() Provides a global AddressResolverGroup that is shared amongst all clients.
protected ConnectionObserver	defaultConnectionObserver() Return the configured default ConnectionObserver.
protected ChannelPipelineConfigurer	defaultOnChannelInit() Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()
Consumer<? super CONF>	doOnConnect() Return the configured callback or null
Consumer<? super Connection>	doOnConnected() Return the configured callback or null
Consumer<? super Connection>	doOnDisconnected() Return the configured callback or null
protected EventLoopGroup	eventLoopGroup() Return the configured EventLoopGroup.
NameResolverProvider	getNameResolverProvider() Return the configured NameResolverProvider or null
boolean	hasProxy() Return true if that ClientTransportConfig is configured with a proxy
ProxyProvider	proxyProvider() Return the ProxyProvider if any or null
protected void	proxyProvider(ProxyProvider proxyProvider)
Supplier<? extends SocketAddress>	remoteAddress() Return the remote configured SocketAddress
AddressResolverGroup<?>	resolver() Return the configured AddressResolverGroup or null.
protected AddressResolverGroup<?>	resolverInternal()

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, channelGroup, channelInitializer, channelOperationsProvider, connectionFactory, connectionObserver, defaultLoggingHandler, defaultLoopResources, defaultMetricsRecorder, doOnChannelInit, isPreferNative, loggingHandler, loggingHandler, loopResources, metricsRecorder, metricsRecorder, metricsRecorderInternal, options, updateMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTransportConfig

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

ClientTransportConfig

protected ClientTransportConfig(ClientTransportConfig<CONF> parent)

Method Detail

channelHash

public int channelHash()

Overrides:

channelHash in class TransportConfig

connectionProvider

public ConnectionProvider connectionProvider()

Return the ConnectionProvider

Returns:

the ConnectionProvider

doOnConnect

@Nullable
public final Consumer<? super CONF> doOnConnect()

Return the configured callback or null

Returns:

the configured callback or null

doOnConnected

@Nullable
public final Consumer<? super Connection> doOnConnected()

Return the configured callback or null

Returns:

the configured callback or null

doOnDisconnected

@Nullable
public final Consumer<? super Connection> doOnDisconnected()

Return the configured callback or null

Returns:

the configured callback or null

hasProxy

public final boolean hasProxy()

Return true if that ClientTransportConfig is configured with a proxy

Returns:

true if that ClientTransportConfig is configured with a proxy

getNameResolverProvider

@Nullable
public NameResolverProvider getNameResolverProvider()

Return the configured NameResolverProvider or null

Returns:

the configured NameResolverProvider or null

proxyProvider

@Nullable
public final ProxyProvider proxyProvider()

Return the ProxyProvider if any or null

Returns:

the ProxyProvider if any or null

remoteAddress

public final Supplier<? extends SocketAddress> remoteAddress()

Return the remote configured SocketAddress

Returns:

the remote configured SocketAddress

resolver

@Nullable
public final AddressResolverGroup<?> resolver()

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

Returns:

the configured AddressResolverGroup or null

channelType

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

Description copied from class: TransportConfig

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

• SocketChannel
• ServerSocketChannel
• DomainSocketChannel
• ServerDomainSocketChannel
• DatagramChannel

Specified by:

channelType in class TransportConfig

Parameters:

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

Returns:

the channel type this configuration is associated with

defaultAddressResolverGroup

protected abstract AddressResolverGroup<?> defaultAddressResolverGroup()

Provides a global AddressResolverGroup that is shared amongst all clients.

Returns:

the global AddressResolverGroup

defaultConnectionObserver

protected ConnectionObserver defaultConnectionObserver()

Description copied from class: TransportConfig

Return the configured default ConnectionObserver.

Specified by:

defaultConnectionObserver in class TransportConfig

Returns:

the configured default ConnectionObserver

defaultOnChannelInit

protected ChannelPipelineConfigurer defaultOnChannelInit()

Description copied from class: TransportConfig

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

Specified by:

defaultOnChannelInit in class TransportConfig

Returns:

the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()

eventLoopGroup

protected EventLoopGroup eventLoopGroup()

Description copied from class: TransportConfig

Return the configured EventLoopGroup.

Specified by:

eventLoopGroup in class TransportConfig

Returns:

the configured EventLoopGroup

proxyProvider

protected void proxyProvider(@Nullable
                             ProxyProvider proxyProvider)

resolverInternal

protected AddressResolverGroup<?> resolverInternal()