reactor.ipc.netty.options

Class ClientOptions.Builder<BUILDER extends ClientOptions.Builder<BUILDER>>

java.lang.Object

reactor.ipc.netty.options.NettyOptions.Builder<io.netty.bootstrap.Bootstrap,ClientOptions,BUILDER>

reactor.ipc.netty.options.ClientOptions.Builder<BUILDER>

All Implemented Interfaces:

java.util.function.Supplier<BUILDER>

Direct Known Subclasses:

HttpClientOptions.Builder

Enclosing class:

ClientOptions

public static class ClientOptions.Builder<BUILDER extends ClientOptions.Builder<BUILDER>>
extends NettyOptions.Builder<io.netty.bootstrap.Bootstrap,ClientOptions,BUILDER>

Field Summary

Fields inherited from class reactor.ipc.netty.options.NettyOptions.Builder

bootstrapTemplate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(io.netty.bootstrap.Bootstrap bootstrapTemplate) Apply common option via super constructor then apply defaultClientOptions(Bootstrap) to the passed bootstrap.

Method Summary

Modifier and Type	Method and Description
ClientOptions	build()
BUILDER	connectAddress(java.util.function.Supplier<? extends java.net.SocketAddress> connectAddressSupplier) The address to which this client should connect.
BUILDER	disablePool() Disable current poolResources
BUILDER	from(ClientOptions options) Fill the builder with attribute values from the provided options.
BUILDER	get()
BUILDER	host(java.lang.String host) The host to which this client should connect.
boolean	isPoolAvailable()
boolean	isPoolDisabled()
BUILDER	poolResources(PoolResources poolResources) Configures the ChannelPool selector for the socket.
BUILDER	port(int port) The port to which this client should connect.
BUILDER	protocolFamily(io.netty.channel.socket.InternetProtocolFamily protocolFamily) Configures the version family for the socket.
BUILDER	proxy(java.util.function.Function<ClientProxyOptions.TypeSpec,ClientProxyOptions.Builder> proxyOptions) The proxy configuration
BUILDER	resolver(io.netty.resolver.AddressResolverGroup<?> resolver) Assign an AddressResolverGroup.
BUILDER	sslSupport() Enable default sslContext support
BUILDER	sslSupport(java.util.function.Consumer<? super io.netty.handler.ssl.SslContextBuilder> configurator) Enable default sslContext support and enable further customization via the passed configurator.

Methods inherited from class reactor.ipc.netty.options.NettyOptions.Builder

afterChannelInit, afterNettyContextInit, attr, channelGroup, eventLoopGroup, isLoopAvailable, loopResources, onChannelInit, option, preferNative, sslCloseNotifyFlushTimeout, sslCloseNotifyFlushTimeoutMillis, sslCloseNotifyReadTimeout, sslCloseNotifyReadTimeoutMillis, sslContext, sslHandshakeTimeout, sslHandshakeTimeoutMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(io.netty.bootstrap.Bootstrap bootstrapTemplate)

Apply common option via super constructor then apply defaultClientOptions(Bootstrap) to the passed bootstrap.

Parameters:

bootstrapTemplate - the bootstrap reference to use

Method Detail

resolver

public final BUILDER resolver(io.netty.resolver.AddressResolverGroup<?> resolver)

Assign an AddressResolverGroup.

Parameters:

resolver - the new AddressResolverGroup

Returns:

this

poolResources

public final BUILDER poolResources(PoolResources poolResources)

Configures the ChannelPool selector for the socket. Will effectively enable client connection-pooling.

Parameters:

poolResources - the PoolResources given an InetSocketAddress

Returns:

this

disablePool

public BUILDER disablePool()

Disable current poolResources

Returns:

this

isPoolDisabled

public final boolean isPoolDisabled()

isPoolAvailable

public final boolean isPoolAvailable()

protocolFamily

public final BUILDER protocolFamily(io.netty.channel.socket.InternetProtocolFamily protocolFamily)

Configures the version family for the socket.

Parameters:

protocolFamily - the version family for the socket, or null for the system default family

Returns:

this

sslSupport

public final BUILDER sslSupport()

Enable default sslContext support

Returns:

this

sslSupport

public final BUILDER sslSupport(java.util.function.Consumer<? super io.netty.handler.ssl.SslContextBuilder> configurator)

Enable default sslContext support and enable further customization via the passed configurator. The builder will then produce the SslContext to be passed to NettyOptions.Builder.sslContext(SslContext).

Parameters:

configurator - builder callback for further customization.

Returns:

this

host

public final BUILDER host(java.lang.String host)

The host to which this client should connect.

Parameters:

host - The host to connect to.

Returns:

this

port

public final BUILDER port(int port)

The port to which this client should connect.

Parameters:

port - The port to connect to.

Returns:

this

connectAddress

public final BUILDER connectAddress(java.util.function.Supplier<? extends java.net.SocketAddress> connectAddressSupplier)

The address to which this client should connect.

Parameters:

connectAddressSupplier - A supplier of the address to connect to.

Returns:

this

proxy

public final BUILDER proxy(java.util.function.Function<ClientProxyOptions.TypeSpec,ClientProxyOptions.Builder> proxyOptions)

The proxy configuration

Parameters:

proxyOptions - the proxy configuration

Returns:

this

from

public final BUILDER from(ClientOptions options)

Description copied from class: NettyOptions.Builder

Fill the builder with attribute values from the provided options.

Overrides:

from in class NettyOptions.Builder<io.netty.bootstrap.Bootstrap,ClientOptions,BUILDER extends ClientOptions.Builder<BUILDER>>

Parameters:

options - The instance from which to copy values

Returns:

this

get

public BUILDER get()

build

public ClientOptions build()