Top Description Inners Fields Constructors Methods
reactor.netty.tcp

public final Class TcpClientConfig

extends ClientTransportConfig<TcpClientConfig>
Class Inheritance
Imports
io.netty.channel.Channel, .ChannelOption, io.netty.handler.logging.LogLevel, .LoggingHandler, io.netty.resolver.AddressResolverGroup, reactor.netty.ChannelPipelineConfigurer, .ConnectionObserver, .ReactorNetty, reactor.netty.channel.ChannelMetricsRecorder, .ChannelOperations, .MicrometerChannelMetricsRecorder, reactor.netty.resources.ConnectionProvider, .LoopResources, reactor.netty.transport.ClientTransportConfig, reactor.netty.transport.logging.AdvancedByteBufFormat, reactor.util.annotation.Nullable, java.net.SocketAddress, java.nio.charset.Charset, java.util.Map, .Objects, java.util.function.Supplier
Encapsulate all necessary configuration for TCP client transport. The public API is read-only.
Author
Violeta Georgieva
Since
1.0.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
TcpClientConfig.MicrometerTcpClientMetricsRecorder

pack-priv static class
TcpClientConfig.TcpClientChannelInitializer

Field Summary

Modifier and TypeField and Description
pack-priv static final ChannelOperations.OnSetup
DEFAULT_OPS

pack-priv static final LoggingHandler
LOGGING_HANDLER

pack-priv static final boolean
SSL_DEBUG

Default value whether the SSL debugging on the client side will be enabled/disabled, fallback to SSL debugging disabled.

pack-priv SslProvider
sslProvider

Constructor Summary

AccessConstructor and Description
pack-priv
TcpClientConfig(ConnectionProvider connectionProvider, Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> remoteAddress)

pack-priv
TcpClientConfig(TcpClientConfig parent)

Method Summary

Modifier and TypeMethod and Description
public int
channelHash()

Overrides reactor.netty.transport.ClientTransportConfig.channelHash.

public ChannelOperations.OnSetup
channelOperationsProvider()

Overrides reactor.netty.transport.TransportConfig.channelOperationsProvider.

Return the associated ChannelOperations.OnSetup, config implementations might override this.
protected AddressResolverGroup<?>

Returns:

the global AddressResolverGroup
defaultAddressResolverGroup()

Implements abstract reactor.netty.transport.ClientTransportConfig.defaultAddressResolverGroup.

Provides a global AddressResolverGroup from TcpResources that is shared amongst all TCP clients.
protected LoggingHandler
defaultLoggingHandler()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoggingHandler.

Return the default LoggingHandler to wiretap this transport.
protected LoopResources
defaultLoopResources()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoopResources.

Return the default LoopResources for this transport.
protected ChannelMetricsRecorder
defaultMetricsRecorder()

Implements abstract reactor.netty.transport.TransportConfig.defaultMetricsRecorder.

Return the configured metrics recorder.
protected ChannelPipelineConfigurer
defaultOnChannelInit()

Overrides reactor.netty.transport.ClientTransportConfig.defaultOnChannelInit.

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

Returns:

true if that TcpClient secured via SSL transport
isSecure()

Return true if that TcpClient secured via SSL transport.

public SslProvider

Returns:

the current SslProvider if that TcpClient secured via SSL transport or null
sslProvider()

Return the current SslProvider if that TcpClient secured via SSL transport or null.

Inherited from reactor.netty.transport.ClientTransportConfig:
channelTypeconnectionProviderdefaultConnectionObserverdoOnConnectdoOnConnecteddoOnDisconnectedeventLoopGroupgetNameResolverProviderhasProxyproxyProviderproxyProviderremoteAddressresolverresolverInternal

Field Detail

DEFAULT_OPSback to summary
pack-priv static final ChannelOperations.OnSetup DEFAULT_OPS
LOGGING_HANDLERback to summary
pack-priv static final LoggingHandler LOGGING_HANDLER
SSL_DEBUGback to summary
pack-priv static final boolean SSL_DEBUG

Default value whether the SSL debugging on the client side will be enabled/disabled, fallback to SSL debugging disabled.

sslProviderback to summary
pack-priv SslProvider sslProvider

Constructor Detail

TcpClientConfigback to summary
pack-priv TcpClientConfig(ConnectionProvider connectionProvider, Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> remoteAddress)
TcpClientConfigback to summary
pack-priv TcpClientConfig(TcpClientConfig parent)

Method Detail

channelHashback to summary
public int channelHash()

Overrides reactor.netty.transport.ClientTransportConfig.channelHash.

Annotations
@Override
channelOperationsProviderback to summary
public ChannelOperations.OnSetup channelOperationsProvider()

Overrides reactor.netty.transport.TransportConfig.channelOperationsProvider.

Doc from reactor.netty.transport.TransportConfig.channelOperationsProvider.

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

Returns:ChannelOperations.OnSetup

the associated ChannelOperations.OnSetup

Annotations
@Override
defaultAddressResolverGroupback to summary
protected AddressResolverGroup<?> defaultAddressResolverGroup()

Implements abstract reactor.netty.transport.ClientTransportConfig.defaultAddressResolverGroup.

Provides a global AddressResolverGroup from TcpResources that is shared amongst all TCP clients. AddressResolverGroup uses the global LoopResources from TcpResources.

Returns:AddressResolverGroup<?>

the global AddressResolverGroup

Annotations
@Override
defaultLoggingHandlerback to summary
protected LoggingHandler defaultLoggingHandler()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoggingHandler.

Doc from reactor.netty.transport.TransportConfig.defaultLoggingHandler.

Return the default LoggingHandler to wiretap this transport.

Returns:LoggingHandler

the default LoggingHandler to wiretap this transport

Annotations
@Override
defaultLoopResourcesback to summary
protected LoopResources defaultLoopResources()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoopResources.

Doc from reactor.netty.transport.TransportConfig.defaultLoopResources.

Return the default LoopResources for this transport.

Returns:LoopResources

the default LoopResources for this transport

Annotations
@Override
defaultMetricsRecorderback to summary
protected ChannelMetricsRecorder defaultMetricsRecorder()

Implements abstract reactor.netty.transport.TransportConfig.defaultMetricsRecorder.

Doc from reactor.netty.transport.TransportConfig.defaultMetricsRecorder.

Return the configured metrics recorder.

Returns:ChannelMetricsRecorder

the configured metrics recorder

Annotations
@Override
defaultOnChannelInitback to summary
protected ChannelPipelineConfigurer defaultOnChannelInit()

Overrides reactor.netty.transport.ClientTransportConfig.defaultOnChannelInit.

Doc from reactor.netty.transport.TransportConfig.defaultOnChannelInit.

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

Returns:ChannelPipelineConfigurer

the default callback if any or ChannelPipelineConfigurer#emptyConfigurer()

Annotations
@Override
isSecureback to summary
public final boolean isSecure()

Return true if that TcpClient secured via SSL transport.

Returns:boolean

true if that TcpClient secured via SSL transport

sslProviderback to summary
public SslProvider sslProvider()

Return the current SslProvider if that TcpClient secured via SSL transport or null.

Returns:SslProvider

the current SslProvider if that TcpClient secured via SSL transport or null

Annotations
@Nullable
reactor.netty.tcp back to summary

pack-priv final Class TcpClientConfig.MicrometerTcpClientMetricsRecorder

extends MicrometerChannelMetricsRecorder
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static final TcpClientConfig.MicrometerTcpClientMetricsRecorder
INSTANCE

Constructor Summary

AccessConstructor and Description
pack-priv
MicrometerTcpClientMetricsRecorder()

Method Summary

Inherited from reactor.netty.channel.MicrometerChannelMetricsRecorder:
filtergetResolveAddressTimergetTlsHandshakeTimerincrementErrorsCountnameprotocolrecordConnectTimerecordDataReceivedrecordDataSentrecordResolveAddressTimerecordServerConnectionClosedrecordServerConnectionOpenedrecordTlsHandshakeTime

Field Detail

INSTANCEback to summary
pack-priv static final TcpClientConfig.MicrometerTcpClientMetricsRecorder INSTANCE

Constructor Detail

MicrometerTcpClientMetricsRecorderback to summary
pack-priv MicrometerTcpClientMetricsRecorder()
reactor.netty.tcp back to summary

pack-priv final Class TcpClientConfig.TcpClientChannelInitializer

extends Object
implements ChannelPipelineConfigurer
Class Inheritance
  • java.lang.Object
  • reactor.netty.tcp.TcpClientConfig.TcpClientChannelInitializer
All Implemented Interfaces
reactor.netty.ChannelPipelineConfigurer

Field Summary

Modifier and TypeField and Description
pack-priv final SslProvider
sslProvider

Constructor Summary

AccessConstructor and Description
pack-priv
TcpClientChannelInitializer(SslProvider sslProvider)

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.netty.ChannelPipelineConfigurer.onChannelInit.

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

Field Detail

sslProviderback to summary
pack-priv final SslProvider sslProvider

Constructor Detail

TcpClientChannelInitializerback to summary
pack-priv TcpClientChannelInitializer(SslProvider sslProvider)

Method Detail

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

Implements reactor.netty.ChannelPipelineConfigurer.onChannelInit.

Doc from reactor.netty.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