reactor.netty.transport

Class ServerTransportConfig<CONF extends TransportConfig>

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.transport.ServerTransportConfig<CONF>

Type Parameters:

CONF - Configuration implementation

Direct Known Subclasses:

TcpServerConfig

public abstract class ServerTransportConfig<CONF extends TransportConfig>
extends TransportConfig

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

Since:

1.0.0

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerTransportConfig(Map<ChannelOption<?>,?> options, Map<ChannelOption<?>,?> childOptions, Supplier<? extends SocketAddress> bindAddress) Default ServerTransportConfig with options
protected	ServerTransportConfig(ServerTransportConfig<CONF> parent)

Method Summary

Modifier and Type	Method and Description
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
Map<AttributeKey<?>,?>	childAttributes() Return the read-only default channel attributes for each remote connection
ConnectionObserver	childObserver() Return the configured ConnectionObserver if any or ConnectionObserver.emptyListener() for each remote connection
Map<ChannelOption<?>,?>	childOptions() Return the read-only ChannelOption map for each remote connection
protected ConnectionObserver	defaultChildObserver() Return the configured child lifecycle ConnectionObserver if any or ConnectionObserver.emptyListener().
protected ConnectionObserver	defaultConnectionObserver() Return the configured default ConnectionObserver.
protected ChannelPipelineConfigurer	defaultOnChannelInit() Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()
Consumer<? super CONF>	doOnBind() Return the configured callback or null
Consumer<? super DisposableServer>	doOnBound() Return the configured callback or null
Consumer<? super Connection>	doOnConnection() Return the configured callback or null
Consumer<? super DisposableServer>	doOnUnbound() Return the configured callback or null
protected EventLoopGroup	eventLoopGroup() Return the configured EventLoopGroup.

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, channelGroup, channelHash, channelInitializer, channelOperationsProvider, connectionFactory, connectionObserver, defaultLoggingHandler, defaultLoopResources, defaultMetricsRecorder, 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

Constructor Detail

ServerTransportConfig

protected ServerTransportConfig(Map<ChannelOption<?>,?> options,
                                Map<ChannelOption<?>,?> childOptions,
                                Supplier<? extends SocketAddress> bindAddress)

Default ServerTransportConfig with options

Parameters:

options - default options for the selector

childOptions - default options for each connected channel

bindAddress - the local address

ServerTransportConfig

protected ServerTransportConfig(ServerTransportConfig<CONF> parent)

Method Detail

childAttributes

public final Map<AttributeKey<?>,?> childAttributes()

Return the read-only default channel attributes for each remote connection

Returns:

the read-only default channel attributes for each remote connection

childObserver

public final ConnectionObserver childObserver()

Return the configured ConnectionObserver if any or ConnectionObserver.emptyListener() for each remote connection

Returns:

the configured ConnectionObserver if any or ConnectionObserver.emptyListener() for each remote connection

childOptions

public final Map<ChannelOption<?>,?> childOptions()

Return the read-only ChannelOption map for each remote connection

Returns:

the read-only ChannelOption map for each remote connection

doOnBind

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

Return the configured callback or null

Returns:

the configured callback or null

doOnBound

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

Return the configured callback or null

Returns:

the configured callback or null

doOnConnection

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

Return the configured callback or null

Returns:

the configured callback or null

doOnUnbound

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

Return the configured callback or null

Returns:

the configured callback 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

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

defaultChildObserver

protected ConnectionObserver defaultChildObserver()

Return the configured child lifecycle ConnectionObserver if any or ConnectionObserver.emptyListener().

Returns:

the configured child lifecycle ConnectionObserver if any or ConnectionObserver.emptyListener()

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

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 final EventLoopGroup eventLoopGroup()

Description copied from class: TransportConfig

Return the configured EventLoopGroup.

Specified by:

eventLoopGroup in class TransportConfig

Returns:

the configured EventLoopGroup