reactor.netty.udp

Class UdpClientConfig

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.transport.ClientTransportConfig<UdpClientConfig>

reactor.netty.udp.UdpClientConfig

public final class UdpClientConfig
extends ClientTransportConfig<UdpClientConfig>

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

Since:

1.0.0

Author:

Violeta Georgieva

Method Summary

Modifier and Type	Method and Description
ChannelOperations.OnSetup	channelOperationsProvider() Return the associated ChannelOperations.OnSetup, config implementations might override this
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
protected ChannelFactory<? extends Channel>	connectionFactory(EventLoopGroup elg, boolean isDomainSocket) Return the ChannelFactory which is used to create Channel instances.
protected AddressResolverGroup<?>	defaultAddressResolverGroup() Provides a global AddressResolverGroup from UdpResources that is shared amongst all UDP clients.
protected LoggingHandler	defaultLoggingHandler() Return the default LoggingHandler to wiretap this transport
protected LoopResources	defaultLoopResources() Return the default LoopResources for this transport
protected ChannelMetricsRecorder	defaultMetricsRecorder() Return the configured metrics recorder.
InternetProtocolFamily	family() Return the configured InternetProtocolFamily to run with or null

Methods inherited from class reactor.netty.transport.ClientTransportConfig

channelHash, connectionProvider, defaultConnectionObserver, defaultOnChannelInit, doOnConnect, doOnConnected, doOnDisconnected, eventLoopGroup, getNameResolverProvider, hasProxy, proxyProvider, proxyProvider, remoteAddress, resolver, resolverInternal

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, channelGroup, channelInitializer, connectionObserver, 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

Method Detail

channelOperationsProvider

public final ChannelOperations.OnSetup channelOperationsProvider()

Description copied from class: TransportConfig

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

Overrides:

channelOperationsProvider in class TransportConfig

Returns:

the associated ChannelOperations.OnSetup

family

@Nullable
public final InternetProtocolFamily family()

Return the configured InternetProtocolFamily to run with or null

Returns:

the configured InternetProtocolFamily to run with 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

Overrides:

channelType in class ClientTransportConfig<UdpClientConfig>

Parameters:

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

Returns:

the channel type this configuration is associated with

connectionFactory

protected ChannelFactory<? extends Channel> connectionFactory(EventLoopGroup elg,
                                                              boolean isDomainSocket)

Description copied from class: TransportConfig

Return the ChannelFactory which is used to create Channel instances.

Overrides:

connectionFactory in class TransportConfig

Parameters:

elg - the EventLoopGroup

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

Returns:

the ChannelFactory which is used to create Channel instances.

defaultAddressResolverGroup

protected AddressResolverGroup<?> defaultAddressResolverGroup()

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

Specified by:

defaultAddressResolverGroup in class ClientTransportConfig<UdpClientConfig>

Returns:

the global AddressResolverGroup

defaultLoggingHandler

protected LoggingHandler defaultLoggingHandler()

Description copied from class: TransportConfig

Return the default LoggingHandler to wiretap this transport

Specified by:

defaultLoggingHandler in class TransportConfig

Returns:

the default LoggingHandler to wiretap this transport

defaultLoopResources

protected LoopResources defaultLoopResources()

Description copied from class: TransportConfig

Return the default LoopResources for this transport

Specified by:

defaultLoopResources in class TransportConfig

Returns:

the default LoopResources for this transport

defaultMetricsRecorder

protected ChannelMetricsRecorder defaultMetricsRecorder()

Description copied from class: TransportConfig

Return the configured metrics recorder.

Specified by:

defaultMetricsRecorder in class TransportConfig

Returns:

the configured metrics recorder