Top Description Inners Fields Constructors Methods
reactor.netty5.tcp

public final Class TcpServerConfig

extends ServerTransportConfig<TcpServerConfig>
Class Inheritance
Imports
io.netty5.channel.Channel, .ChannelOption, io.netty5.handler.logging.LogLevel, .LoggingHandler, reactor.netty5.ChannelPipelineConfigurer, .ConnectionObserver, .ReactorNetty, reactor.netty5.channel.ChannelMetricsRecorder, .ChannelOperations, .MicrometerChannelMetricsRecorder, reactor.netty5.resources.LoopResources, reactor.netty5.transport.ServerTransportConfig, reactor.netty5.transport.logging.AdvancedBufferFormat, reactor.util.annotation.Nullable, java.net.SocketAddress, java.nio.charset.Charset, java.util.Map, java.util.function.Supplier
Encapsulate all necessary configuration for TCP server 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
TcpServerConfig.MicrometerTcpServerMetricsRecorder

pack-priv static class
TcpServerConfig.TcpServerChannelInitializer

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 server side will be enabled/disabled, fallback to SSL debugging disabled

pack-priv SslProvider
sslProvider

Constructor Summary

AccessConstructor and Description
pack-priv
TcpServerConfig(Map<ChannelOption<?>, ?> options, Map<ChannelOption<?>, ?> childOptions, Supplier<? extends SocketAddress> localAddress)

pack-priv
TcpServerConfig(TcpServerConfig parent)

Method Summary

Modifier and TypeMethod and Description
public ChannelOperations.OnSetup
channelOperationsProvider()

Overrides reactor.netty5.transport.TransportConfig.channelOperationsProvider.

Return the associated ChannelOperations.OnSetup, config implementations might override this
protected LoggingHandler
defaultLoggingHandler()

Implements abstract reactor.netty5.transport.TransportConfig.defaultLoggingHandler.

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

Implements abstract reactor.netty5.transport.TransportConfig.defaultLoopResources.

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

Implements abstract reactor.netty5.transport.TransportConfig.defaultMetricsRecorder.

Return the configured metrics recorder.
protected ChannelPipelineConfigurer
defaultOnChannelInit()

Overrides reactor.netty5.transport.ServerTransportConfig.defaultOnChannelInit.

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

Returns:

true if that TcpServer secured via SSL transport
isSecure()

Returns true if that TcpServer secured via SSL transport

public SslProvider

Returns:

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

Returns the current SslProvider if that TcpServer secured via SSL transport or null.

Inherited from reactor.netty5.transport.ServerTransportConfig:
channelTypechildAttributeschildObserverchildOptionsconnectionFactorydefaultChildObserverdefaultConnectionObserverdoOnBinddoOnBounddoOnConnectiondoOnUnboundeventLoopGroup

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 server side will be enabled/disabled, fallback to SSL debugging disabled

sslProviderback to summary
pack-priv SslProvider sslProvider

Constructor Detail

TcpServerConfigback to summary
pack-priv TcpServerConfig(Map<ChannelOption<?>, ?> options, Map<ChannelOption<?>, ?> childOptions, Supplier<? extends SocketAddress> localAddress)
TcpServerConfigback to summary
pack-priv TcpServerConfig(TcpServerConfig parent)

Method Detail

channelOperationsProviderback to summary
public ChannelOperations.OnSetup channelOperationsProvider()

Overrides reactor.netty5.transport.TransportConfig.channelOperationsProvider.

Doc from reactor.netty5.transport.TransportConfig.channelOperationsProvider.

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

Returns:ChannelOperations.OnSetup

the associated ChannelOperations.OnSetup

Annotations
@Override
defaultLoggingHandlerback to summary
protected LoggingHandler defaultLoggingHandler()

Implements abstract reactor.netty5.transport.TransportConfig.defaultLoggingHandler.

Doc from reactor.netty5.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.netty5.transport.TransportConfig.defaultLoopResources.

Doc from reactor.netty5.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.netty5.transport.TransportConfig.defaultMetricsRecorder.

Doc from reactor.netty5.transport.TransportConfig.defaultMetricsRecorder.

Return the configured metrics recorder.

Returns:ChannelMetricsRecorder

the configured metrics recorder

Annotations
@Override
defaultOnChannelInitback to summary
protected ChannelPipelineConfigurer defaultOnChannelInit()

Overrides reactor.netty5.transport.ServerTransportConfig.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
isSecureback to summary
public final boolean isSecure()

Returns true if that TcpServer secured via SSL transport

Returns:boolean

true if that TcpServer secured via SSL transport

sslProviderback to summary
public SslProvider sslProvider()

Returns the current SslProvider if that TcpServer secured via SSL transport or null.

Returns:SslProvider

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

Annotations
@Nullable
reactor.netty5.tcp back to summary

pack-priv final Class TcpServerConfig.MicrometerTcpServerMetricsRecorder

extends MicrometerChannelMetricsRecorder
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static final TcpServerConfig.MicrometerTcpServerMetricsRecorder
INSTANCE

Constructor Summary

AccessConstructor and Description
pack-priv
MicrometerTcpServerMetricsRecorder()

Method Summary

Inherited from reactor.netty5.channel.MicrometerChannelMetricsRecorder:
filtergetResolveAddressTimergetTlsHandshakeTimerincrementErrorsCountnameprotocolrecordConnectTimerecordDataReceivedrecordDataSentrecordResolveAddressTimerecordServerConnectionClosedrecordServerConnectionOpenedrecordTlsHandshakeTime

Field Detail

INSTANCEback to summary
pack-priv static final TcpServerConfig.MicrometerTcpServerMetricsRecorder INSTANCE

Constructor Detail

MicrometerTcpServerMetricsRecorderback to summary
pack-priv MicrometerTcpServerMetricsRecorder()
reactor.netty5.tcp back to summary

pack-priv final Class TcpServerConfig.TcpServerChannelInitializer

extends Object
implements ChannelPipelineConfigurer
Class Inheritance
  • java.lang.Object
  • reactor.netty5.tcp.TcpServerConfig.TcpServerChannelInitializer
All Implemented Interfaces
reactor.netty5.ChannelPipelineConfigurer

Field Summary

Modifier and TypeField and Description
pack-priv final SslProvider
sslProvider

Constructor Summary

AccessConstructor and Description
pack-priv
TcpServerChannelInitializer(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.netty5.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

TcpServerChannelInitializerback to summary
pack-priv TcpServerChannelInitializer(SslProvider sslProvider)

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