Package reactor.netty.udp

Class UdpServerConfig

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.udp.UdpServerConfig

public final class UdpServerConfig
extends TransportConfig

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

Since:

1.0.0

Author:

Violeta Georgieva

Method Summary

Modifier and Type	Method	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.
protected ChannelFactory<? extends Channel>	connectionFactory(EventLoopGroup elg, boolean isDomainSocket)	Return the ChannelFactory which is used to create Channel instances.
protected ConnectionObserver	defaultConnectionObserver()	Return the configured default ConnectionObserver.
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.
protected ChannelPipelineConfigurer	defaultOnChannelInit()	Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer().
final @Nullable Consumer<? super UdpServerConfig>	doOnBind()	Return the configured callback or null.
final @Nullable Consumer<? super Connection>	doOnBound()	Return the configured callback or null.
final @Nullable Consumer<? super Connection>	doOnUnbound()	Return the configured callback or null.
protected EventLoopGroup	eventLoopGroup()	Return the configured EventLoopGroup.
final @Nullable InternetProtocolFamily	family()	Deprecated. as of 1.3.0.
final @Nullable SocketProtocolFamily	socketFamily()	Return the configured SocketProtocolFamily to run with or null.

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, bindAddress, channelGroup, channelHash, 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 Details

channelOperationsProvider

public 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

doOnBind

public final @Nullable Consumer<? super UdpServerConfig> doOnBind()

Return the configured callback or null.

Returns:

the configured callback or null

doOnBound

public final @Nullable Consumer<? super Connection> doOnBound()

Return the configured callback or null.

Returns:

the configured callback or null

doOnUnbound

public final @Nullable Consumer<? super Connection> doOnUnbound()

Return the configured callback or null.

Returns:

the configured callback or null

family

@Deprecated
public final @Nullable InternetProtocolFamily family()

Deprecated.

as of 1.3.0. Prefer socketFamily(). This method will be removed in version 1.4.0.

Return the configured InternetProtocolFamily to run with or null.

Returns:

the configured InternetProtocolFamily to run with or null

socketFamily

public final @Nullable SocketProtocolFamily socketFamily()

Return the configured SocketProtocolFamily to run with or null.

Returns:

the configured SocketProtocolFamily to run with or null

Since:

1.3.0

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

Specified by:

channelType in class TransportConfig

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.

defaultConnectionObserver

protected ConnectionObserver defaultConnectionObserver()

Description copied from class: TransportConfig

Return the configured default ConnectionObserver.

Specified by:

defaultConnectionObserver in class TransportConfig

Returns:

the configured default ConnectionObserver

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

defaultOnChannelInit

protected ChannelPipelineConfigurer defaultOnChannelInit()

Description copied from class: TransportConfig

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

Specified by:

defaultOnChannelInit in class TransportConfig

Returns:

the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()

eventLoopGroup

protected EventLoopGroup eventLoopGroup()

Description copied from class: TransportConfig

Return the configured EventLoopGroup.

Specified by:

eventLoopGroup in class TransportConfig

Returns:

the configured EventLoopGroup