Top Description Fields Constructors Methods
reactor.netty.http.client

pack-priv final Class HttpClientTcpConfig

extends TcpClient
Class Inheritance
Annotations
@Deprecated
Imports
io.netty.channel.ChannelOption, .EventLoopGroup, io.netty.channel.group.ChannelGroup, io.netty.handler.logging.LogLevel, io.netty.resolver.AddressResolverGroup, io.netty.util.AttributeKey, org.reactivestreams.Publisher, reactor.core.publisher.Mono, reactor.netty.ChannelPipelineConfigurer, .Connection, .ConnectionObserver, .NettyInbound, .NettyOutbound, reactor.netty.channel.ChannelMetricsRecorder, reactor.netty.resources.LoopResources, reactor.netty.tcp.SslProvider, .TcpClient, .TcpClientConfig, reactor.netty.transport.ProxyProvider, reactor.util.annotation.Nullable, java.net.SocketAddress, java.util.function.BiFunction, .Consumer, .Function, .Supplier

Deprecated

Use HttpClient methods for TCP level configurations. This class will be removed in version 1.1.0.

This class provides a migration for the HttpClient#tcpConfiguration(Function) in 0.9.x.
Author
Violeta Georgieva

Field Summary

Modifier and TypeField and Description
pack-priv HttpClient
httpClient

Constructor Summary

AccessConstructor and Description
pack-priv
HttpClientTcpConfig(HttpClient httpClient)

Method Summary

Modifier and TypeMethod and Description
public <A> TcpClient
attr(AttributeKey<A>
the AttributeKey key
key, A
the AttributeKey value
value)

Overrides reactor.netty.tcp.TcpClient.attr.

Update the given attribute key or remove it if the value is null.
public TcpClient
bindAddress(Supplier<? extends SocketAddress>
A supplier of the address to bind to.
bindAddressSupplier)

Overrides reactor.netty.tcp.TcpClient.bindAddress.

Set a new local address to which this transport should bind on subscribe.
public TcpClient
channelGroup(ChannelGroup
a ChannelGroup
channelGroup)

Overrides reactor.netty.transport.Transport.channelGroup.

Provide a ChannelGroup to hold all active connected channels.
public TcpClientConfig
configuration()

Implements abstract reactor.netty.transport.Transport.configuration.

Return a TransportConfig.
public Mono<? extends Connection>
connect()

Overrides reactor.netty.tcp.TcpClient.connect.

Connect the ClientTransport and return a Mono of Connection.
public TcpClient
doOnChannelInit(ChannelPipelineConfigurer
configure the channel pipeline while initializing the channel
doOnChannelInit)

Overrides reactor.netty.transport.Transport.doOnChannelInit.

Configure the channel pipeline while initializing the channel.
public TcpClient
doOnConnect(Consumer<? super TcpClientConfig>
a consumer observing connect events
doOnConnect)

Overrides reactor.netty.tcp.TcpClient.doOnConnect.

Set or add a callback called when ClientTransport is about to connect to the remote endpoint.
public TcpClient
doOnConnected(Consumer<? super Connection>
a consumer observing connected events
doOnConnected)

Overrides reactor.netty.tcp.TcpClient.doOnConnected.

Set or add a callback called after Connection has been connected.
public TcpClient
doOnDisconnected(Consumer<? super Connection>
a consumer observing disconnected events
doOnDisconnected)

Overrides reactor.netty.tcp.TcpClient.doOnDisconnected.

Set or add a callback called after Connection has been disconnected.
protected TcpClient
duplicate()

Implements abstract reactor.netty.transport.Transport.duplicate.

Return a new Transport inheriting the current configuration.
public TcpClient
handle(BiFunction<? super NettyInbound, ? super NettyOutbound, ? extends Publisher<Void>>
an IO handler that can dispose underlying connection when Publisher terminates.
handler)

Overrides reactor.netty.tcp.TcpClient.handle.

Attach an IO handler to react on connected client.
public TcpClient
host(String
the host to connect to
host)

Overrides reactor.netty.tcp.TcpClient.host.

The host to which this client should connect.
public TcpClient
metrics(boolean
true enables metrics collection; false disables it
enable)

Overrides reactor.netty.tcp.TcpClient.metrics.

Whether to enable metrics to be collected and registered in Micrometer's globalRegistry.
public TcpClient
metrics(boolean
if true enables the metrics on the Transport.
enable, Supplier<? extends ChannelMetricsRecorder>
a supplier for the ChannelMetricsRecorder
recorder)

Overrides reactor.netty.tcp.TcpClient.metrics.

Specifies whether the metrics are enabled on the Transport.
public TcpClient
noProxy()

Overrides reactor.netty.tcp.TcpClient.noProxy.

Remove any previously applied Proxy configuration customization.
public TcpClient
noSSL()

Overrides reactor.netty.tcp.TcpClient.noSSL.

Remove any previously applied SSL configuration customization.
public TcpClient
observe(ConnectionObserver
the ConnectionObserver to be set or add
observer)

Overrides reactor.netty.tcp.TcpClient.observe.

Set or add the given ConnectionObserver to observe the connection state changes.
public <O> TcpClient
option(ChannelOption<O>
the ChannelOption key
key, O
the ChannelOption value or null
value)

Overrides reactor.netty.tcp.TcpClient.option.

Update the given option key or remove it if the value is null.
public TcpClient
port(int
the port to connect to
port)

Overrides reactor.netty.tcp.TcpClient.port.

The port to which this client should connect.
public TcpClient
proxy(Consumer<? super ProxyProvider.TypeSpec>
the proxy configuration callback
proxyOptions)

Overrides reactor.netty.tcp.TcpClient.proxy.

Apply a proxy configuration.
public TcpClient
remoteAddress(Supplier<? extends SocketAddress>
A supplier of the address to connect to.
remoteAddressSupplier)

Overrides reactor.netty.tcp.TcpClient.remoteAddress.

The address to which this client should connect on each subscribe.
public TcpClient
resolver(AddressResolverGroup<?>
the new AddressResolverGroup
resolver)

Overrides reactor.netty.tcp.TcpClient.resolver.

Assign an AddressResolverGroup.
public TcpClient
runOn(EventLoopGroup
an eventLoopGroup to share
eventLoopGroup)

Overrides reactor.netty.tcp.TcpClient.runOn.

Run IO loops on the given EventLoopGroup.
public TcpClient
runOn(LoopResources
a LoopResources accepting native runtime expectation and returning an eventLoopGroup
channelResources)

Overrides reactor.netty.tcp.TcpClient.runOn.

Run IO loops on a supplied EventLoopGroup from the LoopResources container.
public TcpClient
runOn(LoopResources
a new loop resources
loopResources, boolean
should prefer running on epoll, kqueue or similar instead of java NIO
preferNative)

Overrides reactor.netty.tcp.TcpClient.runOn.

Run IO loops on a supplied EventLoopGroup from the LoopResources container.
public TcpClient
secure()

Overrides reactor.netty.tcp.TcpClient.secure.

Enable default sslContext support.
public TcpClient
secure(Consumer<? super SslProvider.SslContextSpec>
builder callback for further customization of SslContext.
sslProviderBuilder)

Overrides reactor.netty.tcp.TcpClient.secure.

Apply an SSL configuration customization via the passed builder.
public TcpClient
secure(SslProvider
The provider to set when configuring SSL
sslProvider)

Overrides reactor.netty.tcp.TcpClient.secure.

Apply an SSL configuration via the passed SslProvider.
public TcpClient
wiretap(boolean
specifies whether the wire logger configuration will be added to the pipeline
enable)

Overrides reactor.netty.tcp.TcpClient.wiretap.

Apply or remove a wire logger configuration using Transport category (logger), DEBUG logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
public TcpClient
wiretap(String
the logger category
category)

Overrides reactor.netty.tcp.TcpClient.wiretap.

Apply a wire logger configuration using the specified category (logger), DEBUG logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
public TcpClient
wiretap(String
the logger category
category, LogLevel
the logger level
level)

Overrides reactor.netty.tcp.TcpClient.wiretap.

Apply a wire logger configuration using the specified category (logger), logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
Inherited from reactor.netty.tcp.TcpClient:
addressSupplierbootstrapconnectNowconnectNowcreatecreatenewConnectionwarmup