Top Description Inners Fields Constructors Methods
reactor.netty.udp

public final Class UdpClientConfig

extends ClientTransportConfig<UdpClientConfig>
Class Inheritance
Imports
io.netty.channel.Channel, .ChannelFactory, .ChannelOption, .EventLoopGroup, io.netty.channel.socket.DatagramChannel, .InternetProtocolFamily, io.netty.channel.socket.nio.NioDatagramChannel, io.netty.channel.unix.DomainDatagramChannel, io.netty.handler.logging.LogLevel, .LoggingHandler, io.netty.resolver.AddressResolverGroup, 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, 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 InternetProtocolFamily
family

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.netty.transport.TransportConfig.channelOperationsProvider.

Return the associated ChannelOperations.OnSetup, config implementations might override this.
protected Class<? extends Channel>
channelType(boolean
true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise
isDomainSocket)

Overrides reactor.netty.transport.ClientTransportConfig.channelType.

Return the channel type this configuration is associated with, it can be one of the following.
protected ChannelFactory<? extends Channel>
connectionFactory(EventLoopGroup
the EventLoopGroup
elg, boolean
true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise
isDomainSocket)

Overrides reactor.netty.transport.TransportConfig.connectionFactory.

Deprecated as a consequence of ChannelFactory being deprecated.
Return the ChannelFactory which is used to create Channel instances.
protected AddressResolverGroup<?>

Returns:

the global AddressResolverGroup
defaultAddressResolverGroup()

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

Provides a global AddressResolverGroup from UdpResources that is shared amongst all UDP 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.
public final InternetProtocolFamily

Returns:

the configured InternetProtocolFamily to run with or null
family()

Return the configured InternetProtocolFamily to run with or null.

Inherited from reactor.netty.transport.ClientTransportConfig:
channelHashconnectionProviderdefaultConnectionObserverdefaultOnChannelInitdoOnConnectdoOnConnecteddoOnDisconnectedeventLoopGroupgetNameResolverProviderhasProxyproxyProviderproxyProviderremoteAddressresolverresolverInternal

Field Detail

DEFAULT_OPSback to summary
pack-priv static final ChannelOperations.OnSetup DEFAULT_OPS
familyback to summary
pack-priv InternetProtocolFamily family
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.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
channelTypeback to summary
protected Class<? extends Channel> channelType(boolean isDomainSocket)

Overrides reactor.netty.transport.ClientTransportConfig.channelType.

Doc from reactor.netty.transport.TransportConfig.channelType.

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

Parameters
isDomainSocket:boolean

true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise

Returns:Class<? extends Channel>

the channel type this configuration is associated with

Annotations
@Override
connectionFactoryback to summary
protected ChannelFactory<? extends Channel> connectionFactory(EventLoopGroup elg, boolean isDomainSocket)

Overrides reactor.netty.transport.TransportConfig.connectionFactory.

Doc from reactor.netty.transport.TransportConfig.connectionFactory.

Deprecated

as a consequence of ChannelFactory being deprecated. See corresponding docs for further information.

Return the ChannelFactory which is used to create Channel instances.

Parameters
elg:EventLoopGroup

the EventLoopGroup

isDomainSocket:boolean

true if io.netty.channel.unix.DomainSocketChannel or io.netty.channel.unix.ServerDomainSocketChannel is needed, false otherwise

Returns:ChannelFactory<? extends Channel>

the ChannelFactory which is used to create Channel instances.

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

Implements abstract reactor.netty.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.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
familyback to summary
public final InternetProtocolFamily family()

Return the configured InternetProtocolFamily to run with or null.

Returns:InternetProtocolFamily

the configured InternetProtocolFamily to run with or null

Annotations
@Nullable
reactor.netty.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.netty.channel.MicrometerChannelMetricsRecorder:
filtergetResolveAddressTimergetTlsHandshakeTimerincrementErrorsCountnameprotocolrecordConnectTimerecordDataReceivedrecordDataSentrecordResolveAddressTimerecordServerConnectionClosedrecordServerConnectionOpenedrecordTlsHandshakeTime

Field Detail

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

Constructor Detail

MicrometerUdpClientMetricsRecorderback to summary
pack-priv MicrometerUdpClientMetricsRecorder()