reactor.ipc.netty.options

Class NettyOptions.Builder<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>,SO extends NettyOptions<BOOTSTRAP,SO>,BUILDER extends NettyOptions.Builder<BOOTSTRAP,SO,BUILDER>>

java.lang.Object

reactor.ipc.netty.options.NettyOptions.Builder<BOOTSTRAP,SO,BUILDER>

All Implemented Interfaces:

java.util.function.Supplier<BUILDER>

Direct Known Subclasses:

ClientOptions.Builder, ServerOptions.Builder

Enclosing class:

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

public abstract static class NettyOptions.Builder<BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?>,SO extends NettyOptions<BOOTSTRAP,SO>,BUILDER extends NettyOptions.Builder<BOOTSTRAP,SO,BUILDER>>
extends java.lang.Object
implements java.util.function.Supplier<BUILDER>

Field Summary

Fields

Modifier and Type	Field and Description
protected BOOTSTRAP	bootstrapTemplate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(BOOTSTRAP bootstrapTemplate)

Method Summary

Modifier and Type	Method and Description
BUILDER	afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit) Setup a callback called after each Channel initialization, once reactor-netty pipeline handlers have been registered.
BUILDER	afterNettyContextInit(java.util.function.Consumer<? super NettyContext> afterNettyContextInit) Setup a callback called after each Channel initialization, once the reactor-netty pipeline handlers have been registered and the NettyContext is available.
<T> BUILDER	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
BUILDER	channelGroup(ChannelGroup channelGroup) Provide a ChannelGroup for each active remote channel will be held in the provided group.
BUILDER	eventLoopGroup(EventLoopGroup eventLoopGroup) Provide a shared EventLoopGroup each Connector handler.
BUILDER	from(SO options) Fill the builder with attribute values from the provided options.
boolean	isLoopAvailable()
BUILDER	loopResources(LoopResources channelResources) Provide an EventLoopGroup supplier.
BUILDER	onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit) Setup a Predicate for each Channel initialization that can be used to prevent the Channel's registration.
<T> BUILDER	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
BUILDER	preferNative(boolean preferNative) Set the preferred native option.
BUILDER	sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout) Set the options to use for configuring SSL close_notify flush timeout.
BUILDER	sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis) Set the options to use for configuring SSL close_notify flush timeout.
BUILDER	sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout) Set the options to use for configuring SSL close_notify read timeout.
BUILDER	sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis) Set the options to use for configuring SSL close_notify read timeout.
BUILDER	sslContext(SslContext sslContext) Set the options to use for configuring SSL.
BUILDER	sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout) Set the options to use for configuring SSL handshake timeout.
BUILDER	sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis) Set the options to use for configuring SSL handshake timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Supplier

get

Field Detail

bootstrapTemplate

protected BOOTSTRAP extends AbstractBootstrap<BOOTSTRAP,?> bootstrapTemplate

Constructor Detail

Builder

protected Builder(BOOTSTRAP bootstrapTemplate)

Method Detail

attr

public <T> BUILDER 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

See Also:

AbstractBootstrap.attr(AttributeKey, Object)

option

public <T> BUILDER 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

value - the option value

Returns:

this

See Also:

AbstractBootstrap.option(ChannelOption, Object)

preferNative

public final BUILDER preferNative(boolean preferNative)

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

Parameters:

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

Returns:

this

loopResources

public final BUILDER 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

isLoopAvailable

public final boolean isLoopAvailable()

eventLoopGroup

public final BUILDER eventLoopGroup(EventLoopGroup eventLoopGroup)

Provide a shared EventLoopGroup each Connector handler.

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

this

channelGroup

public final BUILDER 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

sslContext

public final BUILDER 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

sslHandshakeTimeout

public final BUILDER 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 final BUILDER 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

sslCloseNotifyFlushTimeout

public final BUILDER sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout)

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Parameters:

sslCloseNotifyFlushTimeout - The timeout Duration

Returns:

this

sslCloseNotifyFlushTimeoutMillis

public final BUILDER sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis)

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Parameters:

sslCloseNotifyFlushTimeoutMillis - The timeout in milliseconds

Returns:

this

sslCloseNotifyReadTimeout

public final BUILDER sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout)

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Parameters:

sslCloseNotifyReadTimeout - The timeout Duration

Returns:

this

sslCloseNotifyReadTimeoutMillis

public final BUILDER sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis)

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Parameters:

sslCloseNotifyReadTimeoutMillis - The timeout in milliseconds

Returns:

this

afterChannelInit

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

Setup a callback called after each Channel initialization, once reactor-netty pipeline handlers have been registered.

Parameters:

afterChannelInit - the post channel setup handler

Returns:

this

See Also:

onChannelInit(Predicate), afterNettyContextInit(Consumer)

onChannelInit

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

Setup a Predicate for each Channel initialization that can be used to prevent the Channel's registration.

Parameters:

onChannelInit - predicate to accept or reject the newly created Channel

Returns:

this

See Also:

afterChannelInit(Consumer), afterNettyContextInit(Consumer)

afterNettyContextInit

public final BUILDER afterNettyContextInit(java.util.function.Consumer<? super NettyContext> afterNettyContextInit)

Setup a callback called after each Channel initialization, once the reactor-netty pipeline handlers have been registered and the NettyContext is available.

Parameters:

afterNettyContextInit - the post channel setup handler

Returns:

this

See Also:

onChannelInit(Predicate), afterChannelInit(Consumer)

from

public BUILDER from(SO options)

Fill the builder with attribute values from the provided options.

Parameters:

options - The instance from which to copy values

Returns:

this