reactor.ipc.netty.options

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

java.lang.Object

reactor.ipc.netty.options.NettyOptions<BOOSTRAP,SO>

Type Parameters:

BOOSTRAP - A Netty Bootstrap type

SO - A NettyOptions subclass

All Implemented Interfaces:

java.util.function.Supplier<BOOSTRAP>

Direct Known Subclasses:

ClientOptions, ServerOptions

public abstract class NettyOptions<BOOSTRAP extends AbstractBootstrap<BOOSTRAP,?>,SO extends NettyOptions<BOOSTRAP,SO>>
extends Object
implements java.util.function.Supplier<BOOSTRAP>

A common connector builder with low-level connection options including sslContext, tcp configuration, channel init handlers.

Author:

Stephane Maldini

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT The default port for reactor-netty servers.

Method Summary

Modifier and Type	Method and Description
java.util.function.Consumer<? super Channel>	afterChannelInit() Returns the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.
SO	afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit) Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.
<T> SO	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
SO	channelGroup(ChannelGroup channelGroup) Provide a ChannelGroup for each active remote channel will be held in the provided group.
protected SslContext	defaultSslContext() Default Ssl context if none configured or null;
abstract SO	duplicate() Return a copy of all options and references such as onChannelInit(Predicate).
SO	eventLoopGroup(EventLoopGroup eventLoopGroup) Provide a shared EventLoopGroup each Connector handler.
BOOSTRAP	get()
abstract SocketAddress	getAddress() Return a new eventual SocketAddress
LoopResources	getLoopResources() Get the configured Loop Resources if any
SslHandler	getSslHandler(ByteBufAllocator allocator, Tuple2<String,Integer> sniInfo) Return a new eventual SslHandler, optionally with SNI activated
SO	loopResources(LoopResources channelResources) Provide an EventLoopGroup supplier.
java.util.function.Predicate<? super Channel>	onChannelInit() Returns the callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.
SO	onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit) A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.
<T> SO	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
boolean	preferNative() Is this option preferring native loops (epoll)
SO	preferNative(boolean preferNative) Set the preferred native option.
SO	sslContext(SslContext sslContext) Set the options to use for configuring SSL.
SO	sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout) Set the options to use for configuring SSL handshake timeout.
SO	sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis) Set the options to use for configuring SSL handshake timeout.
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.

Method Detail

afterChannelInit

public final java.util.function.Consumer<? super Channel> afterChannelInit()

Returns the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.

Returns:

the post channel setup handler

See Also:

onChannelInit()

afterChannelInit

public SO afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit)

Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.

Parameters:

afterChannelInit - the post channel setup handler

Returns:

this

See Also:

onChannelInit(Predicate)

attr

public <T> SO attr(AttributeKey<T> key,
                   T value)

Attribute default attribute to the future Channel connection. They will be available via NettyInbound.attr(AttributeKey).

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

this builder

See Also:

AbstractBootstrap.attr(AttributeKey, Object)

channelGroup

public SO channelGroup(ChannelGroup channelGroup)

Provide a ChannelGroup for each active remote channel will be held in the provided group.

Parameters:

channelGroup - a ChannelGroup to monitor remote channel

Returns:

this builder

loopResources

public SO loopResources(LoopResources channelResources)

Provide an EventLoopGroup supplier. Note that server might call it twice for both their selection and io loops.

Parameters:

channelResources - a selector accepting native runtime expectation and returning an eventLoopGroup

Returns:

this builder

duplicate

public abstract SO duplicate()

Return a copy of all options and references such as onChannelInit(Predicate). Further option uses on the returned builder will be fully isolated from this option builder.

Returns:

a new duplicated builder;

eventLoopGroup

public SO eventLoopGroup(EventLoopGroup eventLoopGroup)

Provide a shared EventLoopGroup each Connector handler.

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

an EventLoopGroup provider given the native runtime expectation

get

public BOOSTRAP get()

Specified by:

get in interface java.util.function.Supplier<BOOSTRAP extends AbstractBootstrap<BOOSTRAP,?>>

getAddress

public abstract 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<String,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 callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.

Returns:

The pre channel pipeline setup handler

See Also:

afterChannelInit()

onChannelInit

public SO onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit)

A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.

Parameters:

onChannelInit - pre channel pipeline setup handler

Returns:

this

See Also:

afterChannelInit(Consumer)

option

public <T> SO option(ChannelOption<T> key,
                     T value)

Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE. This will apply to each new channel from remote peer.

Type Parameters:

T - the option type

Parameters:

key - the option key

Returns:

this

See Also:

AbstractBootstrap.option(ChannelOption, Object)

preferNative

public SO preferNative(boolean preferNative)

Set the preferred native option. Determine if epoll should be used if available.

Parameters:

preferNative - Should the connector prefer native (epoll) if available

Returns:

this

preferNative

public final boolean preferNative()

Is this option preferring native loops (epoll)

Returns:

true if this option is preferring native loops (epoll)

sslContext

public SO sslContext(SslContext sslContext)

Set the options to use for configuring SSL. Setting this to null means don't use SSL at all (the default).

Parameters:

sslContext - The context to set when configuring SSL

Returns:

this

defaultSslContext

protected SslContext defaultSslContext()

Default Ssl context if none configured or null;

Returns:

a default SslContext

sslHandshakeTimeout

public SO sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout)

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Parameters:

sslHandshakeTimeout - The timeout Duration

Returns:

this

sslHandshakeTimeoutMillis

public SO sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis)

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Parameters:

sslHandshakeTimeoutMillis - The timeout in milliseconds

Returns:

this

toString

public String toString()

Overrides:

toString in class Object