reactor.ipc.netty.options

Class ClientOptions

java.lang.Object

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

reactor.ipc.netty.options.ClientOptions

All Implemented Interfaces:

java.util.function.Supplier<io.netty.bootstrap.Bootstrap>

Direct Known Subclasses:

HttpClientOptions

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

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

Author:

Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientOptions.Builder<BUILDER extends ClientOptions.Builder<BUILDER>>

Field Summary

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

afterChannelInit, afterNettyContextInit, DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientOptions(ClientOptions.Builder<?> builder) Deep-copy all references from the passed builder into this new NettyOptions instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	asDetailedString()
java.lang.String	asSimpleString()
static <BUILDER extends ClientOptions.Builder<BUILDER>> ClientOptions.Builder<BUILDER>	builder() Creates a builder for ClientOptions
static <BUILDER extends ClientOptions.Builder<BUILDER>> ClientOptions.Builder<BUILDER>	builder(io.netty.bootstrap.Bootstrap bootstrap) Creates a builder for ClientOptions
protected java.net.InetSocketAddress	createInetSocketAddress(java.lang.String hostname, int port, boolean resolve)
ClientOptions	duplicate() Return a copy of all options and references such as NettyOptions.Builder.onChannelInit(Predicate).
io.netty.bootstrap.Bootstrap	get()
java.net.SocketAddress	getAddress() Return a new eventual SocketAddress
PoolResources	getPoolResources() Get the configured Pool Resources if any
ClientProxyOptions	getProxyOptions()
java.lang.String	toString()
protected boolean	useDatagramChannel() Return true if DatagramChannel should be used
boolean	useProxy(java.net.SocketAddress address) Return true if proxy options have been set and the host is not configured to bypass the proxy.
boolean	useProxy(java.lang.String hostName) Return true if proxy options have been set and the host is not configured to bypass the proxy.

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

afterChannelInit, afterNettyContextInit, defaultSslContext, getLoopResources, getSslHandler, isSecure, onChannelInit, preferNative, sslCloseNotifyFlushTimeoutMillis, sslCloseNotifyReadTimeoutMillis, sslContext, sslHandshakeTimeoutMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientOptions

protected ClientOptions(ClientOptions.Builder<?> builder)

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

Parameters:

builder - the ClientOptions builder

Method Detail

builder

public static <BUILDER extends ClientOptions.Builder<BUILDER>> ClientOptions.Builder<BUILDER> builder()

Creates a builder for ClientOptions

Type Parameters:

BUILDER - A ClientOptions.Builder subclass

Returns:

a new ClientOptions builder

builder

public static <BUILDER extends ClientOptions.Builder<BUILDER>> ClientOptions.Builder<BUILDER> builder(io.netty.bootstrap.Bootstrap bootstrap)

Creates a builder for ClientOptions

Type Parameters:

BUILDER - A ClientOptions.Builder subclass

Parameters:

bootstrap - the bootstrap reference to use

Returns:

a new ClientOptions builder

duplicate

public ClientOptions duplicate()

Description copied from class: NettyOptions

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.

Specified by:

duplicate in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

Returns:

a new duplicated builder;

get

public io.netty.bootstrap.Bootstrap get()

Specified by:

get in interface java.util.function.Supplier<io.netty.bootstrap.Bootstrap>

Overrides:

get in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

getAddress

public final java.net.SocketAddress getAddress()

Description copied from class: NettyOptions

Return a new eventual SocketAddress

Specified by:

getAddress in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

Returns:

the supplied SocketAddress or null

getPoolResources

public final PoolResources getPoolResources()

Get the configured Pool Resources if any

Returns:

an eventual PoolResources

getProxyOptions

public final ClientProxyOptions getProxyOptions()

useDatagramChannel

protected boolean useDatagramChannel()

Return true if DatagramChannel should be used

Returns:

true if DatagramChannel should be used

useProxy

public boolean useProxy(java.net.SocketAddress address)

Return true if proxy options have been set and the host is not configured to bypass the proxy.

Parameters:

address - The address to which this client should connect.

Returns:

true if proxy options have been set and the host is not configured to bypass the proxy.

useProxy

public boolean useProxy(java.lang.String hostName)

Return true if proxy options have been set and the host is not configured to bypass the proxy.

Parameters:

hostName - The host name to which this client should connect.

Returns:

true if proxy options have been set and the host is not configured to bypass the proxy.

asSimpleString

public java.lang.String asSimpleString()

Overrides:

asSimpleString in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

asDetailedString

public java.lang.String asDetailedString()

Overrides:

asDetailedString in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

toString

public java.lang.String toString()

Overrides:

toString in class NettyOptions<io.netty.bootstrap.Bootstrap,ClientOptions>

createInetSocketAddress

protected java.net.InetSocketAddress createInetSocketAddress(java.lang.String hostname,
                                                             int port,
                                                             boolean resolve)