NettyOptions (Reactor Netty 0.7.3.RELEASE)

java.lang.Object
- reactor.ipc.netty.options.NettyOptions<BOOTSTRAP,SO>

Type Parameters:

BOOTSTRAP - A Netty Bootstrap type

SO - A NettyOptions subclass

All Implemented Interfaces:

java.util.function.Supplier<BOOTSTRAP>

Direct Known Subclasses:

ClientOptions, ServerOptions
```
public abstract class NettyOptions<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>,SO extends NettyOptions<BOOTSTRAP,SO>>
extends java.lang.Object
implements java.util.function.Supplier<BOOTSTRAP>
```
A common connector builder with low-level connection options including sslContext, tcp configuration, channel init handlers.

Author:

Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NettyOptions.Builder<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>,SO extends NettyOptions<BOOTSTRAP,SO>,BUILDER extends NettyOptions.Builder<BOOTSTRAP,SO,BUILDER>>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.function.Consumer<? super Channel>`	`afterChannelInit`
`protected java.util.function.Consumer<? super NettyContext>`	`afterNettyContextInit`
`static int`	`DEFAULT_PORT` The default port for reactor-netty servers.

Constructor Summary

Constructors
Modifier Constructor and Description

protected NettyOptions(NettyOptions.Builder<BOOTSTRAP,SO,?> builder)

Constructors
Modifier	Constructor and Description
`protected`	`NettyOptions(NettyOptions.Builder<BOOTSTRAP,SO,?> builder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.function.Consumer<? super Channel>`	`afterChannelInit()` Returns the callback for post `Channel` initialization and reactor-netty pipeline handlers registration.
`java.util.function.Consumer<? super NettyContext>`	`afterNettyContextInit()` Returns the callback for post `Channel` initialization, reactor-netty pipeline handlers registration and `NettyContext` initialisation.
`java.lang.String`	`asDetailedString()`
`java.lang.String`	`asSimpleString()`
`protected SslContext`	`defaultSslContext()` Default Ssl context if none configured or null;
`abstract SO`	`duplicate()` Return a copy of all options and references such as `NettyOptions.Builder.onChannelInit(Predicate)`.
`BOOTSTRAP`	`get()`
`abstract java.net.SocketAddress`	`getAddress()` Return a new eventual `SocketAddress`
`LoopResources`	`getLoopResources()` Get the configured Loop Resources if any
`SslHandler`	`getSslHandler(ByteBufAllocator allocator, Tuple2<java.lang.String,java.lang.Integer> sniInfo)` Return a new eventual `SslHandler`, optionally with SNI activated
`boolean`	`isSecure()` Checks if these options denotes secured communication, ie.
`java.util.function.Predicate<? super Channel>`	`onChannelInit()` Returns the predicate used to validate each `Channel` post initialization (but before reactor-netty pipeline handlers have been registered).
`boolean`	`preferNative()` Is this option preferring native loops (epoll/kqueue)
`long`	`sslCloseNotifyFlushTimeoutMillis()` Returns the SSL close_notify flush timeout in millis
`long`	`sslCloseNotifyReadTimeoutMillis()` Returns the SSL close_notify read timeout in millis
`SslContext`	`sslContext()` Returns the SslContext
`long`	`sslHandshakeTimeoutMillis()` Returns the SSL handshake timeout in millis
`java.lang.String`	`toString()`

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

- Field Detail
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    The default port for reactor-netty servers. Defaults to 12012 but can be tuned via the PORT environment variable.
  - afterChannelInit
```
protected final java.util.function.Consumer<? super Channel> afterChannelInit
```
  - afterNettyContextInit
```
protected final java.util.function.Consumer<? super NettyContext> afterNettyContextInit
```
- Constructor Detail
  - NettyOptions
```
protected NettyOptions(NettyOptions.Builder<BOOTSTRAP,SO,?> builder)
```
- Method Detail
  - afterChannelInit
```
public final java.util.function.Consumer<? super Channel> afterChannelInit()
```
    Returns the callback for post Channel initialization and reactor-netty pipeline handlers registration.
    
    Returns:
    
    the post channel setup handler
    
    See Also:
    
    onChannelInit(), afterNettyContextInit()
  - afterNettyContextInit
```
public final java.util.function.Consumer<? super NettyContext> afterNettyContextInit()
```
    Returns the callback for post Channel initialization, reactor-netty pipeline handlers registration and NettyContext initialisation.
    
    Returns:
    
    the post NettyContext setup handler
    
    See Also:
    
    onChannelInit(), afterChannelInit()
  - isSecure
```
public boolean isSecure()
```
    Checks if these options denotes secured communication, ie. a SSLContext was set other than the default one.
    
    Returns:
    
    true if the options denote secured communication (SSL is active)
  - duplicate
```
public abstract SO duplicate()
```
    Return a copy of all options and references such as NettyOptions.Builder.onChannelInit(Predicate). Further option uses on the returned builder will be fully isolated from this option builder.
    
    Returns:
    
    a new duplicated builder;
  - get
```
public BOOTSTRAP get()
```
    Specified by:
    
    get in interface java.util.function.Supplier<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>>
  - getAddress
```
public abstract java.net.SocketAddress getAddress()
```
    Return a new eventual SocketAddress
    
    Returns:
    
    the supplied SocketAddress or null
  - getLoopResources
```
public final LoopResources getLoopResources()
```
    Get the configured Loop Resources if any
    
    Returns:
    
    an eventual LoopResources
  - getSslHandler
```
public final SslHandler getSslHandler(ByteBufAllocator allocator,
                                      Tuple2<java.lang.String,java.lang.Integer> sniInfo)
```
    Return a new eventual SslHandler, optionally with SNI activated
    
    Parameters:
    
    allocator - ByteBufAllocator to allocate for packet storage
    
    sniInfo - Tuple2 with hostname and port for SNI (any null will skip SNI).
    
    Returns:
    
    a new eventual SslHandler with SNI activated
  - onChannelInit
```
public final java.util.function.Predicate<? super Channel> onChannelInit()
```
    Returns the predicate used to validate each Channel post initialization (but before reactor-netty pipeline handlers have been registered).
    
    Returns:
    
    The channel validator
    
    See Also:
    
    afterChannelInit(), afterNettyContextInit()
  - preferNative
```
public final boolean preferNative()
```
    Is this option preferring native loops (epoll/kqueue)
    
    Returns:
    
    true if this option is preferring native loops (epoll/kqueue)
  - sslContext
```
public final SslContext sslContext()
```
    Returns the SslContext
    
    Returns:
    
    the SslContext
  - sslHandshakeTimeoutMillis
```
public final long sslHandshakeTimeoutMillis()
```
    Returns the SSL handshake timeout in millis
    
    Returns:
    
    the SSL handshake timeout in millis
  - sslCloseNotifyFlushTimeoutMillis
```
public final long sslCloseNotifyFlushTimeoutMillis()
```
    Returns the SSL close_notify flush timeout in millis
    
    Returns:
    
    the SSL close_notify flush timeout in millis
  - sslCloseNotifyReadTimeoutMillis
```
public final long sslCloseNotifyReadTimeoutMillis()
```
    Returns the SSL close_notify read timeout in millis
    
    Returns:
    
    the SSL close_notify read timeout in millis
  - defaultSslContext
```
protected SslContext defaultSslContext()
```
    Default Ssl context if none configured or null;
    
    Returns:
    
    a default SslContext
  - asSimpleString
```
public java.lang.String asSimpleString()
```
  - asDetailedString
```
public java.lang.String asDetailedString()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class NettyOptions<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>,SO extends NettyOptions<BOOTSTRAP,SO>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

afterChannelInit

afterNettyContextInit

Constructor Detail

NettyOptions

Method Detail

afterChannelInit

afterNettyContextInit

isSecure

duplicate

get

getAddress

getLoopResources

getSslHandler

onChannelInit

preferNative

sslContext

sslHandshakeTimeoutMillis

sslCloseNotifyFlushTimeoutMillis

sslCloseNotifyReadTimeoutMillis

defaultSslContext

asSimpleString

asDetailedString

toString