TcpClient (Reactor Netty 0.9.21.RELEASE)

java.lang.Object
- reactor.netty.tcp.TcpClient

```
public abstract class TcpClient
extends Object
```
A TcpClient allows to build in a safe immutable way a TCP client that is materialized and connecting when connect(Bootstrap) is ultimately called.
Internally, materialization happens in two phases, first configure() is called to retrieve a ready to use Bootstrap then connect(Bootstrap) is called.
Example:
```
 
 TcpClient.create()
          .doOnConnect(connectMetrics)
          .doOnConnected(connectedMetrics)
          .doOnDisconnected(disconnectedMetrics)
          .host("127.0.0.1")
          .port(1234)
          .secure()
          .connect()
          .block()
 
```
Author:

Stephane Maldini

Constructor Summary

Constructors
Constructor and Description

TcpClient()

Constructors
Constructor and Description
`TcpClient()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TcpClient`	`addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectAddressSupplier)` Deprecated. as of 0.9.7. Use `remoteAddress(Supplier)`
`<T> TcpClient`	`attr(AttributeKey<T> key, T value)` Inject default attribute to the future `Channel` connection.
`TcpClient`	`bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier)` The address to which this client should bind on subscribe.
`TcpClient`	`bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper)` Deprecated. as of 0.9.10. Use the methods exposed on `TcpClient` level. The method will be removed in version 1.1.0.
`Bootstrap`	`configure()` Materialize a Bootstrap from the parent `TcpClient` chain to use with `connect(Bootstrap)` or separately
`Mono<? extends Connection>`	`connect()` Bind the `TcpClient` and return a `Mono` of `Connection`.
`abstract Mono<? extends Connection>`	`connect(Bootstrap b)` Connect the `TcpClient` and return a `Mono` of `Connection`
`Connection`	`connectNow()` Block the `TcpClient` and return a `Connection`.
`Connection`	`connectNow(java.time.Duration timeout)` Block the `TcpClient` and return a `Connection`.
`static TcpClient`	`create()` Prepare a pooled `TcpClient`
`static TcpClient`	`create(ConnectionProvider provider)` Prepare a `TcpClient`
`TcpClient`	`doOnConnect(java.util.function.Consumer<? super Bootstrap> doOnConnect)` Setup a callback called when `Channel` is about to connect.
`TcpClient`	`doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected)` Setup a callback called after `Channel` has been connected.
`TcpClient`	`doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected)` Setup a callback called after `Channel` has been disconnected.
`TcpClient`	`doOnLifecycle(java.util.function.Consumer<? super Bootstrap> doOnConnect, java.util.function.Consumer<? super Connection> doOnConnected, java.util.function.Consumer<? super Connection> doOnDisconnected)` Deprecated. as of 0.9.7. Use `doOnConnect(Consumer)`, `doOnConnected(Consumer)` or `doOnDisconnected(Consumer)`
`TcpClient`	`handle(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<Void>> handler)` Attach an IO handler to react on connected client
`boolean`	`hasProxy()` Return true if that `TcpClient` is configured with a proxy
`TcpClient`	`host(String host)` The host to which this client should connect.
`boolean`	`isSecure()` Return true if that `TcpClient` secured via SSL transport
`TcpClient`	`metrics(boolean metricsEnabled)` Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry` under the name `Metrics.TCP_CLIENT_PREFIX`.
`TcpClient`	`metrics(boolean metricsEnabled, ChannelMetricsRecorder recorder)` Deprecated. as of 0.9.7. Use `metrics(boolean, Supplier)`
`TcpClient`	`metrics(boolean metricsEnabled, java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)` Specifies whether the metrics are enabled on the `TcpClient`.
`static TcpClient`	`newConnection()` Prepare a non pooled `TcpClient`
`TcpClient`	`noProxy()` Remove any previously applied Proxy configuration customization
`TcpClient`	`noSSL()` Remove any previously applied SSL configuration customization
`TcpClient`	`observe(ConnectionObserver observer)` Setup all lifecycle callbacks called on or after `Channel` has been connected and after it has been disconnected.
`<T> TcpClient`	`option(ChannelOption<T> key, T value)` Set a `ChannelOption` value for low level connection settings like `SO_TIMEOUT` or `SO_KEEPALIVE`.
`TcpClient`	`port(int port)` The port to which this client should connect.
`TcpClient`	`proxy(java.util.function.Consumer<? super ProxyProvider.TypeSpec> proxyOptions)` Apply a proxy configuration
`ProxyProvider`	`proxyProvider()` Return the current `ProxyProvider` if any
`TcpClient`	`remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier)` The address to which this client should connect for each subscribe.
`TcpClient`	`resolver(AddressResolverGroup<?> resolver)` Assign an `AddressResolverGroup`.
`TcpClient`	`runOn(EventLoopGroup eventLoopGroup)` Run IO loops on the given `EventLoopGroup`.
`TcpClient`	`runOn(LoopResources channelResources)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`TcpClient`	`runOn(LoopResources channelResources, boolean preferNative)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`TcpClient`	`secure()` Enable default sslContext support.
`TcpClient`	`secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)` Apply an SSL configuration customization via the passed builder.
`TcpClient`	`secure(SslProvider sslProvider)` Apply an SSL configuration via the passed `SslProvider`.
`SslProvider`	`sslProvider()` Return the current `SslProvider` if that `TcpClient` secured via SSL transport or null
`TcpClient`	`wiretap(boolean enable)` Apply or remove a wire logger configuration using `TcpClient` category and `DEBUG` logger level
`TcpClient`	`wiretap(String category)` Apply a wire logger configuration using the specified category and `DEBUG` logger level
`TcpClient`	`wiretap(String category, LogLevel level)` Apply a wire logger configuration using the specified category and logger level

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TcpClient
```
public TcpClient()
```
- Method Detail
  - create
```
public static TcpClient create()
```
    Prepare a pooled TcpClient
    
    Returns:
    
    a TcpClient
  - create
```
public static TcpClient create(ConnectionProvider provider)
```
    Prepare a TcpClient
    
    Parameters:
    
    provider - a ConnectionProvider to acquire connections
    
    Returns:
    
    a TcpClient
  - newConnection
```
public static TcpClient newConnection()
```
    Prepare a non pooled TcpClient
    
    Returns:
    
    a TcpClient
  - addressSupplier
```
@Deprecated
public final TcpClient addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectAddressSupplier)
```
    Deprecated. as of 0.9.7. Use remoteAddress(Supplier)
    
    The address to which this client should connect for each subscribe.
    
    Parameters:
    
    connectAddressSupplier - A supplier of the address to connect to.
    
    Returns:
    
    a new TcpClient
  - remoteAddress
```
public final TcpClient remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier)
```
    The address to which this client should connect for each subscribe.
    
    Parameters:
    
    remoteAddressSupplier - A supplier of the address to connect to.
    
    Returns:
    
    a new TcpClient
    
    Since:
    
    0.9.7
  - attr
```
public final <T> TcpClient attr(AttributeKey<T> key,
                                @Nullable
                                T value)
```
    Inject default attribute to the future Channel connection. They will be available via AttributeMap.attr(AttributeKey). If the value is null, the attribute of the specified key is removed.
    
    Type Parameters:
    
    T - the attribute type
    
    Parameters:
    
    key - the attribute key
    
    value - the attribute value
    
    Returns:
    
    a new TcpClient
    
    See Also:
    
    AbstractBootstrap.attr(AttributeKey, Object)
  - bindAddress
```
public final TcpClient bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier)
```
    The address to which this client should bind on subscribe.
    
    Parameters:
    
    bindAddressSupplier - A supplier of the address to bind to.
    
    Returns:
    
    a new TcpClient
    
    Since:
    
    0.9.10
  - bootstrap
```
@Deprecated
public final TcpClient bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper)
```
    Deprecated. as of 0.9.10. Use the methods exposed on TcpClient level. The method will be removed in version 1.1.0.
    
    Apply Bootstrap configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.
    Configuration will apply during configure() phase.
    
    Parameters:
    
    bootstrapMapper - A bootstrap mapping function to update configuration and return an enriched bootstrap.
    
    Returns:
    
    a new TcpClient
  - configure
```
public Bootstrap configure()
```
    Materialize a Bootstrap from the parent TcpClient chain to use with connect(Bootstrap) or separately
    
    Returns:
    
    a configured Bootstrap
  - connect
```
public final Mono<? extends Connection> connect()
```
    Bind the TcpClient and return a Mono of Connection. If Mono is cancelled, the underlying connection will be aborted. Once the Connection has been emitted and is not necessary anymore, disposing must be done by the user via DisposableChannel.dispose(). If update configuration phase fails, a Mono.error(Throwable) will be returned
    
    Returns:
    
    a Mono of Connection
  - connect
```
public abstract Mono<? extends Connection> connect(Bootstrap b)
```
    Connect the TcpClient and return a Mono of Connection
    
    Parameters:
    
    b - the Bootstrap to connect
    
    Returns:
    
    a Mono of Connection
  - connectNow
```
public final Connection connectNow()
```
    Block the TcpClient and return a Connection. Disposing must be done by the user via DisposableChannel.dispose(). The max connection timeout is 45 seconds.
    
    Returns:
    
    a Mono of Connection
  - connectNow
```
public final Connection connectNow(java.time.Duration timeout)
```
    Block the TcpClient and return a Connection. Disposing must be done by the user via DisposableChannel.dispose().
    
    Parameters:
    
    timeout - connect timeout
    
    Returns:
    
    a Mono of Connection
  - doOnConnect
```
public final TcpClient doOnConnect(java.util.function.Consumer<? super Bootstrap> doOnConnect)
```
    Setup a callback called when Channel is about to connect.
    
    Parameters:
    
    doOnConnect - a runnable observing connected events
    
    Returns:
    
    a new TcpClient
  - doOnConnected
```
public final TcpClient doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected)
```
    Setup a callback called after Channel has been connected.
    
    Parameters:
    
    doOnConnected - a consumer observing connected events
    
    Returns:
    
    a new TcpClient
  - doOnDisconnected
```
public final TcpClient doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected)
```
    Setup a callback called after Channel has been disconnected.
    
    Parameters:
    
    doOnDisconnected - a consumer observing disconnected events
    
    Returns:
    
    a new TcpClient
  - doOnLifecycle
```
@Deprecated
public final TcpClient doOnLifecycle(java.util.function.Consumer<? super Bootstrap> doOnConnect,
                                                 java.util.function.Consumer<? super Connection> doOnConnected,
                                                 java.util.function.Consumer<? super Connection> doOnDisconnected)
```
    Deprecated. as of 0.9.7. Use doOnConnect(Consumer), doOnConnected(Consumer) or doOnDisconnected(Consumer)
    
    Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.
    
    Parameters:
    
    doOnConnect - a consumer observing client start event
    
    doOnConnected - a consumer observing client started event
    
    doOnDisconnected - a consumer observing client stop event
    
    Returns:
    
    a new TcpClient
  - host
```
public final TcpClient host(String host)
```
    The host to which this client should connect.
    
    Parameters:
    
    host - The host to connect to.
    
    Returns:
    
    a new TcpClient
  - handle
```
public final TcpClient handle(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<Void>> handler)
```
    Attach an IO handler to react on connected client
    
    Parameters:
    
    handler - an IO handler that can dispose underlying connection when Publisher terminates.
    
    Returns:
    
    a new TcpClient
  - hasProxy
```
public final boolean hasProxy()
```
    Return true if that TcpClient is configured with a proxy
    
    Returns:
    
    true if that TcpClient is configured with a proxy
  - isSecure
```
public final boolean isSecure()
```
    Return true if that TcpClient secured via SSL transport
    
    Returns:
    
    true if that TcpClient secured via SSL transport
  - noProxy
```
public final TcpClient noProxy()
```
    Remove any previously applied Proxy configuration customization
    
    Returns:
    
    a new TcpClient
  - noSSL
```
public final TcpClient noSSL()
```
    Remove any previously applied SSL configuration customization
    
    Returns:
    
    a new TcpClient
  - observe
```
public final TcpClient observe(ConnectionObserver observer)
```
    Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.
    
    Parameters:
    
    observer - a consumer observing state changes
    
    Returns:
    
    a new TcpClient
  - option
```
public final <T> TcpClient option(ChannelOption<T> key,
                                  @Nullable
                                  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. Use a value of null to remove a previous set ChannelOption.
    
    Type Parameters:
    
    T - the option type
    
    Parameters:
    
    key - the option key
    
    value - the option value
    
    Returns:
    
    new TcpClient
    
    See Also:
    
    AbstractBootstrap.option(ChannelOption, Object)
  - port
```
public final TcpClient port(int port)
```
    The port to which this client should connect.
    
    Parameters:
    
    port - The port to connect to.
    
    Returns:
    
    a new TcpClient
  - proxy
```
public final TcpClient proxy(java.util.function.Consumer<? super ProxyProvider.TypeSpec> proxyOptions)
```
    Apply a proxy configuration
    
    Parameters:
    
    proxyOptions - the proxy configuration callback
    
    Returns:
    
    a new TcpClient
  - proxyProvider
```
@Nullable
public ProxyProvider proxyProvider()
```
    Return the current ProxyProvider if any
    
    Returns:
    
    the current ProxyProvider if any
  - resolver
```
public final TcpClient resolver(AddressResolverGroup<?> resolver)
```
    Assign an AddressResolverGroup.
    
    Parameters:
    
    resolver - the new AddressResolverGroup
    
    Returns:
    
    a new TcpClient
  - runOn
```
public final TcpClient runOn(EventLoopGroup eventLoopGroup)
```
    Run IO loops on the given EventLoopGroup.
    
    Parameters:
    
    eventLoopGroup - an eventLoopGroup to share
    
    Returns:
    
    a new TcpClient
  - runOn
```
public final TcpClient runOn(LoopResources channelResources)
```
    Run IO loops on a supplied EventLoopGroup from the LoopResources container. Will prefer native (epoll/kqueue) implementation if available unless the environment property reactor.netty.native is set to false.
    
    Parameters:
    
    channelResources - a LoopResources accepting native runtime expectation and returning an eventLoopGroup
    
    Returns:
    
    a new TcpClient
  - runOn
```
public final TcpClient runOn(LoopResources channelResources,
                             boolean preferNative)
```
    Run IO loops on a supplied EventLoopGroup from the LoopResources container.
    
    Parameters:
    
    channelResources - a LoopResources accepting native runtime expectation and returning an eventLoopGroup.
    
    preferNative - Should the connector prefer native (epoll/kqueue) if available.
    
    Returns:
    
    a new TcpClient
  - secure
```
public final TcpClient secure()
```
    Enable default sslContext support. The default SslContext will be assigned to with a default value of 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set.
    
    Returns:
    
    a new TcpClient
  - secure
```
public final TcpClient secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)
```
    Apply an SSL configuration customization via the passed builder. The builder will produce the SslContext to be passed to with a default value of 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set.
    
    Parameters:
    
    sslProviderBuilder - builder callback for further customization of SslContext.
    
    Returns:
    
    a new TcpClient
  - secure
```
public final TcpClient secure(SslProvider sslProvider)
```
    Apply an SSL configuration via the passed SslProvider.
    
    Parameters:
    
    sslProvider - The provider to set when configuring SSL
    
    Returns:
    
    a new TcpClient
  - sslProvider
```
@Nullable
public SslProvider sslProvider()
```
    Return the current SslProvider if that TcpClient secured via SSL transport or null
    
    Returns:
    
    the current SslProvider if that TcpClient secured via SSL transport or null
  - metrics
```
public final TcpClient metrics(boolean metricsEnabled)
```
    Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.TCP_CLIENT_PREFIX. Applications can separately register their own filters associated with this name. For example, to put an upper bound on the number of tags produced:
```
 MeterFilter filter = ... ;
 Metrics.globalRegistry.config().meterFilter(MeterFilter.maximumAllowableTags(TCP_CLIENT_PREFIX, 100, filter));
 
```
    By default this is not enabled.
    Parameters:
    
    metricsEnabled - true enables metrics collection; false disables it
    
    Returns:
    
    a new TcpClient
  - metrics
```
@Deprecated
public final TcpClient metrics(boolean metricsEnabled,
                                           ChannelMetricsRecorder recorder)
```
    Deprecated. as of 0.9.7. Use metrics(boolean, Supplier)
    
    Specifies whether the metrics are enabled on the TcpClient. All generated metrics are provided to the specified recorder.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the client.
    
    recorder - the ChannelMetricsRecorder
    
    Returns:
    
    a new TcpClient
  - metrics
```
public final TcpClient metrics(boolean metricsEnabled,
                               java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)
```
    Specifies whether the metrics are enabled on the TcpClient. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the client.
    
    recorder - a supplier for the ChannelMetricsRecorder
    
    Returns:
    
    a new TcpClient
    
    Since:
    
    0.9.7
  - wiretap
```
public final TcpClient wiretap(boolean enable)
```
    Apply or remove a wire logger configuration using TcpClient category and DEBUG logger level
    
    Parameters:
    
    enable - Specifies whether the wire logger configuration will be added to the pipeline
    
    Returns:
    
    a new TcpClient
  - wiretap
```
public final TcpClient wiretap(String category)
```
    Apply a wire logger configuration using the specified category and DEBUG logger level
    
    Parameters:
    
    category - the logger category
    
    Returns:
    
    a new TcpClient
  - wiretap
```
public final TcpClient wiretap(String category,
                               LogLevel level)
```
    Apply a wire logger configuration using the specified category and logger level
    
    Parameters:
    
    category - the logger category
    
    level - the logger level
    
    Returns:
    
    a new TcpClient

Class TcpClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TcpClient

Method Detail

create

create

newConnection

addressSupplier

remoteAddress

attr

bindAddress

bootstrap

configure

connect

connect

connectNow

connectNow

doOnConnect

doOnConnected

doOnDisconnected

doOnLifecycle

host

handle

hasProxy

isSecure

noProxy

noSSL

observe

option

port

proxy

proxyProvider

resolver

runOn

runOn

runOn

secure

secure

secure

sslProvider

metrics

metrics

metrics

wiretap

wiretap

wiretap