reactor.ipc.netty.options

Class ClientOptions

java.lang.Object

reactor.ipc.netty.options.NettyOptions<Bootstrap,ClientOptions>

reactor.ipc.netty.options.ClientOptions

All Implemented Interfaces:

java.util.function.Supplier<Bootstrap>

Direct Known Subclasses:

HttpClientOptions

public class ClientOptions
extends NettyOptions<Bootstrap,ClientOptions>

A client connector builder with low-level connection options including connection pooling and proxy.

Author:

Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientOptions.Proxy Proxy Type

Field Summary

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

DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientOptions() Build a new ClientOptions out of a new Bootstrap
protected	ClientOptions(Bootstrap bootstrap) Apply common option via super constructor then apply defaultClientOptions(Bootstrap) to the passed bootstrap.
protected	ClientOptions(ClientOptions options) Deep-copy all references from the passed options into this new NettyOptions instance.

Method Summary

Modifier and Type	Method and Description
ClientOptions	connect(InetSocketAddress connectAddress) The address to which this client should connect.
ClientOptions	connect(int port) The localhost port to which this client should connect.
ClientOptions	connect(String host, int port) The host and port to which this client should connect.
ClientOptions	connect(java.util.function.Supplier<? extends InetSocketAddress> connectAddress) The address to which this client should connect.
static ClientOptions	create() Create a client builder.
ClientOptions	disablePool() Disable current poolResources
ClientOptions	duplicate() Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate).
Bootstrap	get()
SocketAddress	getAddress() Return a new eventual SocketAddress
PoolResources	getPoolResources() Get the configured Pool Resources if any
ProxyHandler	getProxyHandler() Return a new eventual ProxyHandler
boolean	isPoolAvailable()
boolean	isPoolDisabled()
ClientOptions	poolResources(PoolResources poolResources) Configures the ChannelPool selector for the socket.
ClientOptions	protocolFamily(InternetProtocolFamily protocolFamily) Configures the version family for the socket.
ClientOptions	proxy(ClientOptions.Proxy type, InetSocketAddress connectAddress) Let this client connect through a proxy by providing an address.
ClientOptions	proxy(ClientOptions.Proxy type, InetSocketAddress connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing an address and credentials.
ClientOptions	proxy(ClientOptions.Proxy type, String host, int port) Let this client connect through a proxy by providing a host and port.
ClientOptions	proxy(ClientOptions.Proxy type, String host, int port, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing a host, port and credentials.
ClientOptions	proxy(ClientOptions.Proxy type, java.util.function.Supplier<? extends InetSocketAddress> connectAddress) Let this client connect through a proxy by providing an address supplier.
ClientOptions	proxy(ClientOptions.Proxy type, java.util.function.Supplier<? extends InetSocketAddress> connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing an address supplier.
ClientOptions	resolver(AddressResolverGroup<?> resolver) Assign an AddressResolverGroup.
ClientOptions	sslSupport() Enable default sslContext support
ClientOptions	sslSupport(java.util.function.Consumer<? super SslContextBuilder> configurator) Enable default sslContext support and enable further customization via the passed configurator.
protected boolean	useDatagramChannel() Return true if DatagramChannel should be used
protected boolean	useProxy() Return true if proxy options have been set

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

afterChannelInit, afterChannelInit, attr, channelGroup, defaultSslContext, eventLoopGroup, getLoopResources, getSslHandler, isLoopAvailable, loopResources, onChannelInit, onChannelInit, option, preferNative, preferNative, sslCloseNotifyFlushTimeout, sslCloseNotifyFlushTimeoutMillis, sslCloseNotifyReadTimeout, sslCloseNotifyReadTimeoutMillis, sslContext, sslHandshakeTimeout, sslHandshakeTimeoutMillis, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientOptions

protected ClientOptions()

Build a new ClientOptions out of a new Bootstrap

ClientOptions

protected ClientOptions(Bootstrap bootstrap)

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

Parameters:

bootstrap - the bootstrap reference to use

ClientOptions

protected ClientOptions(ClientOptions options)

Deep-copy all references from the passed options into this new NettyOptions instance.

Parameters:

options - the source options to duplicate

Method Detail

create

public static ClientOptions create()

Create a client builder.

Returns:

a new client options builder

connect

public ClientOptions connect(int port)

The localhost port to which this client should connect.

Parameters:

port - The port to connect to.

Returns:

this

connect

public ClientOptions connect(@Nonnull
                             String host,
                             int port)

The host and port to which this client should connect.

Parameters:

host - The host to connect to.

port - The port to connect to.

Returns:

this

connect

public ClientOptions connect(@Nonnull
                             InetSocketAddress connectAddress)

The address to which this client should connect.

Parameters:

connectAddress - The address to connect to.

Returns:

this

connect

public ClientOptions connect(@Nonnull
                             java.util.function.Supplier<? extends InetSocketAddress> connectAddress)

The address to which this client should connect.

Parameters:

connectAddress - A supplier of the address to connect to.

Returns:

this

disablePool

public ClientOptions disablePool()

Disable current poolResources

Returns:

this

isPoolDisabled

public final boolean isPoolDisabled()

isPoolAvailable

public final boolean isPoolAvailable()

duplicate

public ClientOptions duplicate()

Description copied from class: NettyOptions

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

Specified by:

duplicate in class NettyOptions<Bootstrap,ClientOptions>

Returns:

a new duplicated builder;

get

public Bootstrap get()

Specified by:

get in interface java.util.function.Supplier<Bootstrap>

Overrides:

get in class NettyOptions<Bootstrap,ClientOptions>

getAddress

public final SocketAddress getAddress()

Description copied from class: NettyOptions

Return a new eventual SocketAddress

Specified by:

getAddress in class NettyOptions<Bootstrap,ClientOptions>

Returns:

the supplied SocketAddress or null

getPoolResources

public final PoolResources getPoolResources()

Get the configured Pool Resources if any

Returns:

an eventual PoolResources

getProxyHandler

public final ProxyHandler getProxyHandler()

Return a new eventual ProxyHandler

Returns:

a new eventual ProxyHandler

poolResources

public ClientOptions 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

protocolFamily

public ClientOptions protocolFamily(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

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           String host,
                           int port,
                           @Nullable
                           String username,
                           @Nullable
                           java.util.function.Function<? super String,? extends String> password)

Let this client connect through a proxy by providing a host, port and credentials.

Parameters:

type - The proxy type.

host - The proxy host to connect to.

port - The proxy port to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           String host,
                           int port)

Let this client connect through a proxy by providing a host and port.

Parameters:

type - The proxy type.

host - The host to connect to.

port - The port to connect to.

Returns:

this

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           InetSocketAddress connectAddress)

Let this client connect through a proxy by providing an address.

Parameters:

type - The proxy type.

connectAddress - The address to connect to.

Returns:

this

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           InetSocketAddress connectAddress,
                           @Nullable
                           String username,
                           @Nullable
                           java.util.function.Function<? super String,? extends String> password)

Let this client connect through a proxy by providing an address and credentials.

Parameters:

type - The proxy type.

connectAddress - The address to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           java.util.function.Supplier<? extends InetSocketAddress> connectAddress)

Let this client connect through a proxy by providing an address supplier.

Parameters:

type - The proxy type.

connectAddress - The supplier for the address to connect to.

Returns:

this

proxy

public ClientOptions proxy(@Nonnull
                           ClientOptions.Proxy type,
                           @Nonnull
                           java.util.function.Supplier<? extends InetSocketAddress> connectAddress,
                           @Nullable
                           String username,
                           @Nullable
                           java.util.function.Function<? super String,? extends String> password)

Let this client connect through a proxy by providing an address supplier.

Parameters:

type - The proxy type.

connectAddress - The supplier for the address to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

resolver

public ClientOptions resolver(AddressResolverGroup<?> resolver)

Assign an AddressResolverGroup.

Parameters:

resolver - the new AddressResolverGroup

Returns:

this ClientOptions

sslSupport

public ClientOptions sslSupport()

Enable default sslContext support

Returns:

this ClientOptions

sslSupport

public ClientOptions sslSupport(java.util.function.Consumer<? super 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.sslContext(SslContext).

Parameters:

configurator - builder callback for further customization.

Returns:

this ClientOptions

useDatagramChannel

protected boolean useDatagramChannel()

Return true if DatagramChannel should be used

Returns:

true if DatagramChannel should be used

useProxy

protected boolean useProxy()

Return true if proxy options have been set

Returns:

true if proxy options have been set