Top Description Inners Fields Constructors Methods
reactor.netty5.udp

public final Class UdpClientConfig

extends ClientTransportConfig<UdpClientConfig>
Class Inheritance
Imports
io.netty5.channel.Channel, .ChannelOption, .ServerChannel, .ServerChannelFactory, io.netty5.channel.socket.DatagramChannel, io.netty5.handler.logging.LogLevel, .LoggingHandler, io.netty5.resolver.AddressResolverGroup, reactor.netty5.channel.ChannelMetricsRecorder, .ChannelOperations, .MicrometerChannelMetricsRecorder, reactor.netty5.resources.ConnectionProvider, .LoopResources, reactor.netty5.transport.ClientTransportConfig, reactor.netty5.transport.logging.AdvancedBufferFormat, reactor.util.annotation.Nullable, java.net.ProtocolFamily, .SocketAddress, java.nio.charset.Charset, java.util.Map, java.util.function.Supplier
Encapsulate all necessary configuration for UDP 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
UdpClientConfig.MicrometerUdpClientMetricsRecorder

Field Summary

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

pack-priv static final LoggingHandler
LOGGING_HANDLER

Constructor Summary

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

pack-priv
UdpClientConfig(UdpClientConfig parent)

Method Summary

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

Overrides reactor.netty5.transport.TransportConfig.channelOperationsProvider.

Return the associated ChannelOperations.OnSetup, config implementations might override this
protected Class<? extends Channel>
channelType()

Overrides reactor.netty5.transport.TransportConfig.channelType.

Return the channel type this configuration is associated with, it can be one of the following:
protected AddressResolverGroup<?>

Returns:

the global AddressResolverGroup
defaultAddressResolverGroup()

Implements abstract reactor.netty5.transport.ClientTransportConfig.defaultAddressResolverGroup.

Provides a global AddressResolverGroup from UdpResources that is shared amongst all UDP clients.
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 Class<? extends ServerChannel>
serverChannelType()

Overrides reactor.netty5.transport.ClientTransportConfig.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.ClientTransportConfig.serverConnectionFactory.

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

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

Constructor Detail

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

Method Detail

channelOperationsProviderback to summary
public final 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
channelTypeback to summary
protected Class<? extends Channel> channelType()

Overrides reactor.netty5.transport.TransportConfig.channelType.

Doc from reactor.netty5.transport.TransportConfig.channelType.

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

Returns:Class<? extends Channel>

the channel type this configuration is associated with

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

Implements abstract reactor.netty5.transport.ClientTransportConfig.defaultAddressResolverGroup.

Provides a global AddressResolverGroup from UdpResources that is shared amongst all UDP clients. AddressResolverGroup uses the global LoopResources from UdpResources.

Returns:AddressResolverGroup<?>

the global AddressResolverGroup

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
serverChannelTypeback to summary
protected Class<? extends ServerChannel> serverChannelType()

Overrides reactor.netty5.transport.ClientTransportConfig.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.ClientTransportConfig.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.udp back to summary

pack-priv final Class UdpClientConfig.MicrometerUdpClientMetricsRecorder

extends MicrometerChannelMetricsRecorder
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static final UdpClientConfig.MicrometerUdpClientMetricsRecorder
INSTANCE

Constructor Summary

AccessConstructor and Description
pack-priv
MicrometerUdpClientMetricsRecorder()

Method Summary

Inherited from reactor.netty5.channel.MicrometerChannelMetricsRecorder:
filtergetResolveAddressTimergetTlsHandshakeTimerincrementErrorsCountnameprotocolrecordConnectTimerecordDataReceivedrecordDataSentrecordResolveAddressTimerecordServerConnectionClosedrecordServerConnectionOpenedrecordTlsHandshakeTime

Field Detail

INSTANCEback to summary
pack-priv static final UdpClientConfig.MicrometerUdpClientMetricsRecorder INSTANCE

Constructor Detail

MicrometerUdpClientMetricsRecorderback to summary
pack-priv MicrometerUdpClientMetricsRecorder()