TransportConfig (reactor-netty 1.0.7)

java.lang.Object
- reactor.netty.transport.TransportConfig

Direct Known Subclasses:

ClientTransportConfig, ServerTransportConfig, UdpServerConfig
```
public abstract class TransportConfig
extends Object
```
A basic configuration holder. The public API is read-only.

Since:

1.0.0

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TransportConfig(Map<ChannelOption<?>,?> options)` Default TransportConfig with options
`protected`	`TransportConfig(Map<ChannelOption<?>,?> options, java.util.function.Supplier<? extends SocketAddress> bindAddress)` Default TransportConfig with options
`protected`	`TransportConfig(TransportConfig parent)` Create TransportConfig from an existing one

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Map<AttributeKey<?>,?>`	`attributes()` Return the read-only default channel attributes
`java.util.function.Supplier<? extends SocketAddress>`	`bindAddress()` Return the local `SocketAddress` supplier that will be bound or null
`ChannelGroup`	`channelGroup()` Return the configured `ChannelGroup` or null
`int`	`channelHash()`
`ChannelInitializer<Channel>`	`channelInitializer(ConnectionObserver connectionObserver, SocketAddress remoteAddress, boolean onServer)` Return the `ChannelInitializer` that will be used for initializing the channel pipeline
`ChannelOperations.OnSetup`	`channelOperationsProvider()` Return the associated `ChannelOperations.OnSetup`, config implementations might override this
`protected abstract 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.
`ConnectionObserver`	`connectionObserver()` Return the configured `ConnectionObserver` if any or `ConnectionObserver.emptyListener()`
`protected abstract ConnectionObserver`	`defaultConnectionObserver()` Return the configured default `ConnectionObserver`.
`protected abstract LoggingHandler`	`defaultLoggingHandler()` Return the default `LoggingHandler` to wiretap this transport
`protected abstract LoopResources`	`defaultLoopResources()` Return the default `LoopResources` for this transport
`protected abstract ChannelMetricsRecorder`	`defaultMetricsRecorder()` Return the configured metrics recorder.
`protected abstract ChannelPipelineConfigurer`	`defaultOnChannelInit()` Return the default callback if any or `ChannelPipelineConfigurer.emptyConfigurer()`
`ChannelPipelineConfigurer`	`doOnChannelInit()` Return the configured callback if any or `ChannelPipelineConfigurer.emptyConfigurer()`
`protected abstract EventLoopGroup`	`eventLoopGroup()` Return the configured `EventLoopGroup`.
`boolean`	`isPreferNative()` Return `true` if prefer native event loop and channel factory (e.g.
`LoggingHandler`	`loggingHandler()` Return the configured `LoggingHandler` or null
`protected void`	`loggingHandler(LoggingHandler loggingHandler)`
`LoopResources`	`loopResources()` Return the configured `LoopResources` or the default
`java.util.function.Supplier<? extends ChannelMetricsRecorder>`	`metricsRecorder()` Return the configured metrics recorder `ChannelMetricsRecorder` or null
`protected void`	`metricsRecorder(java.util.function.Supplier<? extends ChannelMetricsRecorder> metricsRecorder)`
`Map<ChannelOption<?>,?>`	`options()` Return the read-only `ChannelOption` map
`protected static <K,V> Map<K,V>`	`updateMap(Map<K,V> parentMap, Object key, Object value)` Add or remove values to a map in an immutable way by returning a new map instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TransportConfig
```
protected TransportConfig(Map<ChannelOption<?>,?> options)
```
    Default TransportConfig with options
  - TransportConfig
```
protected TransportConfig(Map<ChannelOption<?>,?> options,
                          java.util.function.Supplier<? extends SocketAddress> bindAddress)
```
    Default TransportConfig with options
  - TransportConfig
```
protected TransportConfig(TransportConfig parent)
```
    Create TransportConfig from an existing one
- Method Detail
  - attributes
```
public final Map<AttributeKey<?>,?> attributes()
```
    Return the read-only default channel attributes
    
    Returns:
    
    the read-only default channel attributes
  - bindAddress
```
@Nullable
public final java.util.function.Supplier<? extends SocketAddress> bindAddress()
```
    Return the local SocketAddress supplier that will be bound or null
    
    Returns:
    
    the SocketAddress supplier
  - channelHash
```
public int channelHash()
```
  - channelGroup
```
@Nullable
public final ChannelGroup channelGroup()
```
    Return the configured ChannelGroup or null
    
    Returns:
    
    the configured ChannelGroup or null
  - channelInitializer
```
public final ChannelInitializer<Channel> channelInitializer(ConnectionObserver connectionObserver,
                                                            @Nullable
                                                            SocketAddress remoteAddress,
                                                            boolean onServer)
```
    Return the ChannelInitializer that will be used for initializing the channel pipeline
    
    Parameters:
    
    connectionObserver - the configured ConnectionObserver
    
    remoteAddress - the remote address
    
    onServer - channel initializer for the server or for the client
    
    Returns:
    
    the ChannelInitializer that will be used for initializing the channel pipeline
  - channelOperationsProvider
```
public ChannelOperations.OnSetup channelOperationsProvider()
```
    Return the associated ChannelOperations.OnSetup, config implementations might override this
    
    Returns:
    
    the associated ChannelOperations.OnSetup
  - connectionObserver
```
public final ConnectionObserver connectionObserver()
```
    Return the configured ConnectionObserver if any or ConnectionObserver.emptyListener()
    
    Returns:
    
    the configured ConnectionObserver if any or ConnectionObserver.emptyListener()
  - doOnChannelInit
```
public final ChannelPipelineConfigurer doOnChannelInit()
```
    Return the configured callback if any or ChannelPipelineConfigurer.emptyConfigurer()
    
    Returns:
    
    the configured callback if any or ChannelPipelineConfigurer.emptyConfigurer()
  - isPreferNative
```
public final boolean isPreferNative()
```
    Return true if prefer native event loop and channel factory (e.g. epoll or kqueue)
    
    Returns:
    
    true if prefer native event loop and channel factory (e.g. epoll or kqueue)
  - loggingHandler
```
@Nullable
public final LoggingHandler loggingHandler()
```
    Return the configured LoggingHandler or null
    
    Returns:
    
    the configured LoggingHandler or null
  - loopResources
```
public final LoopResources loopResources()
```
    Return the configured LoopResources or the default
    
    Returns:
    
    the configured LoopResources or the default
  - metricsRecorder
```
@Nullable
public final java.util.function.Supplier<? extends ChannelMetricsRecorder> metricsRecorder()
```
    Return the configured metrics recorder ChannelMetricsRecorder or null
    
    Returns:
    
    the configured metrics recorder ChannelMetricsRecorder or null
  - options
```
public final Map<ChannelOption<?>,?> options()
```
    Return the read-only ChannelOption map
    
    Returns:
    
    the read-only ChannelOption map
  - channelType
```
protected abstract Class<? extends Channel> channelType(boolean isDomainSocket)
```
    Return the channel type this configuration is associated with, it can be one of the following:
    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)
```
    Return the ChannelFactory which is used to create Channel instances.
    
    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 abstract ConnectionObserver defaultConnectionObserver()
```
    Return the configured default ConnectionObserver.
    
    Returns:
    
    the configured default ConnectionObserver
  - defaultLoggingHandler
```
protected abstract LoggingHandler defaultLoggingHandler()
```
    Return the default LoggingHandler to wiretap this transport
    
    Returns:
    
    the default LoggingHandler to wiretap this transport
  - defaultLoopResources
```
protected abstract LoopResources defaultLoopResources()
```
    Return the default LoopResources for this transport
    
    Returns:
    
    the default LoopResources for this transport
  - defaultMetricsRecorder
```
protected abstract ChannelMetricsRecorder defaultMetricsRecorder()
```
    Return the configured metrics recorder.
    
    Returns:
    
    the configured metrics recorder
  - defaultOnChannelInit
```
protected abstract ChannelPipelineConfigurer defaultOnChannelInit()
```
    Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()
    
    Returns:
    
    the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()
  - eventLoopGroup
```
protected abstract EventLoopGroup eventLoopGroup()
```
    Return the configured EventLoopGroup.
    
    Returns:
    
    the configured EventLoopGroup
  - loggingHandler
```
protected void loggingHandler(LoggingHandler loggingHandler)
```
  - metricsRecorder
```
protected void metricsRecorder(@Nullable
                               java.util.function.Supplier<? extends ChannelMetricsRecorder> metricsRecorder)
```
  - updateMap
```
protected static <K,V> Map<K,V> updateMap(Map<K,V> parentMap,
                                          Object key,
                                          @Nullable
                                          Object value)
```
    Add or remove values to a map in an immutable way by returning a new map instance.
    
    Type Parameters:
    
    K - key type to add
    
    V - value to add
    
    Parameters:
    
    parentMap - the container map to update
    
    key - the key to update
    
    value - the new value or null to remove an existing key
    
    Returns:
    
    a new instance of the map

Class TransportConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransportConfig

TransportConfig

TransportConfig

Method Detail

attributes

bindAddress

channelHash

channelGroup

channelInitializer

channelOperationsProvider

connectionObserver

doOnChannelInit

isPreferNative

loggingHandler

loopResources

metricsRecorder

options

channelType

connectionFactory

defaultConnectionObserver

defaultLoggingHandler

defaultLoopResources

defaultMetricsRecorder

defaultOnChannelInit

eventLoopGroup

loggingHandler

metricsRecorder

updateMap