ClientTransport (reactor-netty 1.0.3 API)

java.lang.Object
- reactor.netty.transport.Transport<T,CONF>
- - reactor.netty.transport.ClientTransport<T,CONF>

Type Parameters:

T - ClientTransport implementation

CONF - Client Configuration implementation

Direct Known Subclasses:

HttpClient, TcpClient, UdpClient
```
public abstract class ClientTransport<T extends ClientTransport<T,CONF>,CONF extends ClientTransportConfig<CONF>>
extends Transport<T,CONF>
```
A generic client Transport that will connect() to a remote address and provide a Connection

Since:

1.0.0

Constructor Summary

Constructors
Constructor and Description

ClientTransport()

Constructors
Constructor and Description
`ClientTransport()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected reactor.core.publisher.Mono<? extends Connection>`	`connect()` Connect the `ClientTransport` and return a `Mono` of `Connection`.
`protected Connection`	`connectNow()` Block the `ClientTransport` and return a `Connection`.
`protected Connection`	`connectNow(java.time.Duration timeout)` Block the `ClientTransport` and return a `Connection`.
`T`	`doAfterResolve(java.util.function.BiConsumer<? super Connection,? super java.net.SocketAddress> doAfterResolve)` Set or add a callback called after `SocketAddress` is resolved successfully.
`T`	`doOnConnect(java.util.function.Consumer<? super CONF> doOnConnect)` Set or add a callback called when `ClientTransport` is about to connect to the remote endpoint.
`T`	`doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected)` Set or add a callback called after `Connection` has been connected.
`T`	`doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected)` Set or add a callback called after `Connection` has been disconnected.
`T`	`doOnResolve(java.util.function.Consumer<? super Connection> doOnResolve)` Set or add a callback called before `SocketAddress` is resolved.
`T`	`doOnResolveError(java.util.function.BiConsumer<? super Connection,? super java.lang.Throwable> doOnResolveError)` Set or add a callback called if an exception happens while resolving to a `SocketAddress`.
`T`	`host(java.lang.String host)` The host to which this client should connect.
`T`	`noProxy()` Remove any previously applied Proxy configuration customization
`T`	`port(int port)` The port to which this client should connect.
`T`	`proxy(java.util.function.Consumer<? super ProxyProvider.TypeSpec> proxyOptions)` Apply a proxy configuration
`T`	`remoteAddress(java.util.function.Supplier<? extends java.net.SocketAddress> remoteAddressSupplier)` The address to which this client should connect on each subscribe.
`T`	`resolver(io.netty.resolver.AddressResolverGroup<?> resolver)` Assign an `AddressResolverGroup`.
`T`	`resolver(java.util.function.Consumer<NameResolverProvider.NameResolverSpec> nameResolverSpec)` Apply a name resolver configuration.
`T`	`runOn(LoopResources loopResources, boolean preferNative)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`reactor.core.publisher.Mono<java.lang.Void>`	`warmup()` Based on the actual configuration, returns a `Mono` that triggers: an initialization of the event loop group an initialization of the host name resolver loads the necessary native libraries for the transport By default, when method is not used, the `connect operation` absorbs the extra time needed to initialize and load the resources.

Methods inherited from class reactor.netty.transport.Transport
attr, bindAddress, channelGroup, configuration, doOnChannelInit, duplicate, metrics, metrics, observe, option, runOn, runOn, wiretap, wiretap, wiretap, wiretap, wiretap

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

- Constructor Detail
  - ClientTransport
```
public ClientTransport()
```
- Method Detail
  - connect
```
protected reactor.core.publisher.Mono<? extends Connection> connect()
```
    Connect the ClientTransport 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().
    
    Returns:
    
    a Mono of Connection
  - connectNow
```
protected Connection connectNow()
```
    Block the ClientTransport and return a Connection. Disposing must be done by the user via DisposableChannel.dispose(). The max connection timeout is 45 seconds.
    
    Returns:
    
    a Connection
  - connectNow
```
protected Connection connectNow(java.time.Duration timeout)
```
    Block the ClientTransport and return a Connection. Disposing must be done by the user via DisposableChannel.dispose().
    
    Parameters:
    
    timeout - connect timeout (resolution: ns)
    
    Returns:
    
    a Connection
  - doOnConnect
```
public T doOnConnect(java.util.function.Consumer<? super CONF> doOnConnect)
```
    Set or add a callback called when ClientTransport is about to connect to the remote endpoint.
    
    Parameters:
    
    doOnConnect - a consumer observing connect events
    
    Returns:
    
    a new ClientTransport reference
  - doOnConnected
```
public T doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected)
```
    Set or add a callback called after Connection has been connected.
    
    Parameters:
    
    doOnConnected - a consumer observing connected events
    
    Returns:
    
    a new ClientTransport reference
  - doOnDisconnected
```
public T doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected)
```
    Set or add a callback called after Connection has been disconnected.
    
    Parameters:
    
    doOnDisconnected - a consumer observing disconnected events
    
    Returns:
    
    a new ClientTransport reference
  - doOnResolve
```
public final T doOnResolve(java.util.function.Consumer<? super Connection> doOnResolve)
```
    Set or add a callback called before SocketAddress is resolved.
    
    Parameters:
    
    doOnResolve - a consumer observing resolve events
    
    Returns:
    
    a new ClientTransport reference
    
    Since:
    
    1.0.1
  - doAfterResolve
```
public final T doAfterResolve(java.util.function.BiConsumer<? super Connection,? super java.net.SocketAddress> doAfterResolve)
```
    Set or add a callback called after SocketAddress is resolved successfully.
    
    Parameters:
    
    doAfterResolve - a consumer observing resolved events
    
    Returns:
    
    a new ClientTransport reference
    
    Since:
    
    1.0.1
  - doOnResolveError
```
public final T doOnResolveError(java.util.function.BiConsumer<? super Connection,? super java.lang.Throwable> doOnResolveError)
```
    Set or add a callback called if an exception happens while resolving to a SocketAddress.
    
    Parameters:
    
    doOnResolveError - a consumer observing resolve error events
    
    Returns:
    
    a new ClientTransport reference
    
    Since:
    
    1.0.1
  - host
```
public T host(java.lang.String host)
```
    The host to which this client should connect.
    
    Parameters:
    
    host - the host to connect to
    
    Returns:
    
    a new ClientTransport reference
  - noProxy
```
public T noProxy()
```
    Remove any previously applied Proxy configuration customization
    
    Returns:
    
    a new ClientTransport reference
  - port
```
public T port(int port)
```
    The port to which this client should connect.
    
    Parameters:
    
    port - the port to connect to
    
    Returns:
    
    a new ClientTransport reference
  - proxy
```
public T proxy(java.util.function.Consumer<? super ProxyProvider.TypeSpec> proxyOptions)
```
    Apply a proxy configuration
    
    Parameters:
    
    proxyOptions - the proxy configuration callback
    
    Returns:
    
    a new ClientTransport reference
  - remoteAddress
```
public T remoteAddress(java.util.function.Supplier<? extends java.net.SocketAddress> remoteAddressSupplier)
```
    The address to which this client should connect on each subscribe.
    
    Parameters:
    
    remoteAddressSupplier - A supplier of the address to connect to.
    
    Returns:
    
    a new ClientTransport
  - resolver
```
public T resolver(io.netty.resolver.AddressResolverGroup<?> resolver)
```
    Assign an AddressResolverGroup.
    
    Parameters:
    
    resolver - the new AddressResolverGroup
    
    Returns:
    
    a new ClientTransport reference
  - resolver
```
public T resolver(java.util.function.Consumer<NameResolverProvider.NameResolverSpec> nameResolverSpec)
```
    Apply a name resolver configuration.
    
    Parameters:
    
    nameResolverSpec - the name resolver callback
    
    Returns:
    
    a new ClientTransport reference
  - runOn
```
public T runOn(LoopResources loopResources,
               boolean preferNative)
```
    Description copied from class: Transport
    
    Run IO loops on a supplied EventLoopGroup from the LoopResources container.
    
    Overrides:
    
    runOn in class Transport<T extends ClientTransport<T,CONF>,CONF extends ClientTransportConfig<CONF>>
    
    Parameters:
    
    loopResources - a new loop resources
    
    preferNative - should prefer running on epoll, kqueue or similar instead of java NIO
    
    Returns:
    
    a new Transport reference
  - warmup
```
public reactor.core.publisher.Mono<java.lang.Void> warmup()
```
    Based on the actual configuration, returns a Mono that triggers:
    - an initialization of the event loop group
    - an initialization of the host name resolver
    - loads the necessary native libraries for the transport
    By default, when method is not used, the connect operation absorbs the extra time needed to initialize and load the resources.
    Returns:
    
    a Mono representing the completion of the warmup
    
    Since:
    
    1.0.3

Class ClientTransport<T extends ClientTransport<T,CONF>,CONF extends ClientTransportConfig<CONF>>

Constructor Summary

Method Summary

Methods inherited from class reactor.netty.transport.Transport

Methods inherited from class java.lang.Object

Constructor Detail

ClientTransport

Method Detail

connect

connectNow

connectNow

doOnConnect

doOnConnected

doOnDisconnected

doOnResolve

doAfterResolve

doOnResolveError

host

noProxy

port

proxy

remoteAddress

resolver

resolver

runOn

warmup