io.reactivex.netty.protocol.tcp.client

Class TcpClientImpl<W,R>

java.lang.Object

io.reactivex.netty.protocol.tcp.client.InterceptingTcpClient<W,R>

io.reactivex.netty.protocol.tcp.client.TcpClient<W,R>

io.reactivex.netty.protocol.tcp.client.TcpClientImpl<W,R>

All Implemented Interfaces:

io.reactivex.netty.events.EventSource<TcpClientEventListener>

public final class TcpClientImpl<W,R>
extends TcpClient<W,R>

Method Summary

Modifier and Type	Method and Description
<WW,RR> TcpClient<WW,RR>	addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerAfter(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerBefore(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerFirst(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<WW,RR> TcpClient<WW,RR>	addChannelHandlerLast(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this client.
<T> TcpClient<W,R>	channelOption(io.netty.channel.ChannelOption<T> option, T value) Creates a new client instances, inheriting all configurations from this client and adding a ChannelOption for the connections created by the newly created client instance.
TcpClient<W,R>	channelProvider(io.reactivex.netty.client.ChannelProviderFactory providerFactory) Creates a new client instance, inheriting all configurations from this client and using the passed providerFactory.
static <W,R> TcpClientImpl<W,R>	create(io.reactivex.netty.client.ConnectionProviderFactory<W,R> factory, rx.Observable<io.reactivex.netty.client.Host> hostStream)
static <W,R> TcpClientImpl<W,R>	create(java.net.SocketAddress socketAddress)
io.reactivex.netty.client.ConnectionRequest<W,R>	createConnectionRequest() Creates a new ConnectionRequest which should be subscribed to actually connect to the target server.
TcpClient<W,R>	enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel) Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.
TcpClientInterceptorChain<W,R>	intercept() Starts the process of adding interceptors to this client.
<WW,RR> TcpClient<WW,RR>	pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator) Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.
TcpClient<W,R>	readTimeOut(int timeOut, java.util.concurrent.TimeUnit timeUnit) Creates a new client instances, inheriting all configurations from this client and enables read timeout for all the connection created by this client.
TcpClient<W,R>	secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory) Creates a new client instance, inheriting all configurations from this client and using the passed sslEngineFactory for all secured connections created by the newly created client instance.
TcpClient<W,R>	secure(io.reactivex.netty.ssl.SslCodec sslCodec) Creates a new client instance, inheriting all configurations from this client and using the passed sslCodec for all secured connections created by the newly created client instance.
TcpClient<W,R>	secure(javax.net.ssl.SSLEngine sslEngine) Creates a new client instance, inheriting all configurations from this client and using the passed sslEngine for all secured connections created by the newly created client instance.
rx.Subscription	subscribe(TcpClientEventListener listener)
TcpClient<W,R>	unsafeSecure() Creates a new client instance, inheriting all configurations from this client and using a trust-all TrustManagerFactoryfor all secured connections created by the newly created client instance.

Methods inherited from class io.reactivex.netty.protocol.tcp.client.TcpClient

newClient, newClient, newClient

Methods inherited from class java.lang.Object

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

Method Detail

createConnectionRequest

public io.reactivex.netty.client.ConnectionRequest<W,R> createConnectionRequest()

Description copied from class: InterceptingTcpClient

Creates a new ConnectionRequest which should be subscribed to actually connect to the target server.

Specified by:

createConnectionRequest in class InterceptingTcpClient<W,R>

Returns:

A new ConnectionRequest which either can be subscribed directly or altered in various ways before subscription.

channelOption

public <T> TcpClient<W,R> channelOption(io.netty.channel.ChannelOption<T> option,
                                        T value)

Description copied from class: TcpClient

Creates a new client instances, inheriting all configurations from this client and adding a ChannelOption for the connections created by the newly created client instance.

Specified by:

channelOption in class TcpClient<W,R>

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpClient instance.

readTimeOut

public TcpClient<W,R> readTimeOut(int timeOut,
                                  java.util.concurrent.TimeUnit timeUnit)

Description copied from class: TcpClient

Creates a new client instances, inheriting all configurations from this client and enables read timeout for all the connection created by this client.

Specified by:

readTimeOut in class TcpClient<W,R>

Parameters:

timeOut - Read timeout duration.

timeUnit - Read timeout time unit.

Returns:

A new TcpClient instance.

addChannelHandlerFirst

public <WW,RR> TcpClient<WW,RR> addChannelHandlerFirst(java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerFirst in class TcpClient<W,R>

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerFirst

public <WW,RR> TcpClient<WW,RR> addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                       java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerFirst in class TcpClient<W,R>

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerLast

public <WW,RR> TcpClient<WW,RR> addChannelHandlerLast(java.lang.String name,
                                                      rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerLast in class TcpClient<W,R>

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerLast

public <WW,RR> TcpClient<WW,RR> addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                      java.lang.String name,
                                                      rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerLast in class TcpClient<W,R>

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerBefore

public <WW,RR> TcpClient<WW,RR> addChannelHandlerBefore(java.lang.String baseName,
                                                        java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(String, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerBefore in class TcpClient<W,R>

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerBefore

public <WW,RR> TcpClient<WW,RR> addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group,
                                                        java.lang.String baseName,
                                                        java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerBefore in class TcpClient<W,R>

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerAfter

public <WW,RR> TcpClient<WW,RR> addChannelHandlerAfter(java.lang.String baseName,
                                                       java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(String, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerAfter in class TcpClient<W,R>

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerAfter

public <WW,RR> TcpClient<WW,RR> addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group,
                                                       java.lang.String baseName,
                                                       java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpClient

Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method TcpClient.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerAfter in class TcpClient<W,R>

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

pipelineConfigurator

public <WW,RR> TcpClient<WW,RR> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)

Description copied from class: TcpClient

Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.

Specified by:

pipelineConfigurator in class TcpClient<W,R>

Parameters:

pipelineConfigurator - Action to configure ChannelPipeline.

Returns:

A new TcpClient instance.

enableWireLogging

public TcpClient<W,R> enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)

Description copied from class: TcpClient

Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.

Specified by:

enableWireLogging in class TcpClient<W,R>

Parameters:

wireLoggingLevel - Logging level at which the wire logs will be logged. The wire logging will only be done if logging is enabled at this level for LoggingHandler

Returns:

A new TcpClient instance.

secure

public TcpClient<W,R> secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory)

Description copied from class: TcpClient

Creates a new client instance, inheriting all configurations from this client and using the passed sslEngineFactory for all secured connections created by the newly created client instance. If the SSLEngine instance can be statically, created, TcpClient.secure(SSLEngine) can be used.

Specified by:

secure in class TcpClient<W,R>

Parameters:

sslEngineFactory - Factory for all secured connections created by the newly created client instance.

Returns:

A new TcpClient instance.

secure

public TcpClient<W,R> secure(javax.net.ssl.SSLEngine sslEngine)

Description copied from class: TcpClient

Creates a new client instance, inheriting all configurations from this client and using the passed sslEngine for all secured connections created by the newly created client instance. If the SSLEngine instance can not be statically, created, TcpClient.secure(Func1) )} can be used.

Specified by:

secure in class TcpClient<W,R>

Parameters:

sslEngine - SSLEngine for all secured connections created by the newly created client instance.

Returns:

A new TcpClient instance.

secure

public TcpClient<W,R> secure(io.reactivex.netty.ssl.SslCodec sslCodec)

Description copied from class: TcpClient

Creates a new client instance, inheriting all configurations from this client and using the passed sslCodec for all secured connections created by the newly created client instance. This is required only when the SslHandler used by SslCodec is to be modified before adding to the ChannelPipeline. For most of the cases, TcpClient.secure(Func1) or TcpClient.secure(SSLEngine) will be enough.

Specified by:

secure in class TcpClient<W,R>

Parameters:

sslCodec - SslCodec for all secured connections created by the newly created client instance.

Returns:

A new TcpClient instance.

unsafeSecure

public TcpClient<W,R> unsafeSecure()

Description copied from class: TcpClient

Creates a new client instance, inheriting all configurations from this client and using a trust-all TrustManagerFactoryfor all secured connections created by the newly created client instance. This is only for testing and should not be used for real production clients.

Specified by:

unsafeSecure in class TcpClient<W,R>

Returns:

A new TcpClient instance.

channelProvider

public TcpClient<W,R> channelProvider(io.reactivex.netty.client.ChannelProviderFactory providerFactory)

Description copied from class: TcpClient

Creates a new client instance, inheriting all configurations from this client and using the passed providerFactory.

Specified by:

channelProvider in class TcpClient<W,R>

Parameters:

providerFactory - Channel provider factory.

Returns:

A new TcpClient instance.

subscribe

public rx.Subscription subscribe(TcpClientEventListener listener)

intercept

public TcpClientInterceptorChain<W,R> intercept()

Description copied from class: InterceptingTcpClient

Starts the process of adding interceptors to this client. Interceptors help in achieving various usecases of instrumenting and transforming connections.

Specified by:

intercept in class InterceptingTcpClient<W,R>

Returns:

A new interceptor chain to add the various interceptors.

create

public static <W,R> TcpClientImpl<W,R> create(java.net.SocketAddress socketAddress)

create

public static <W,R> TcpClientImpl<W,R> create(io.reactivex.netty.client.ConnectionProviderFactory<W,R> factory,
                                              rx.Observable<io.reactivex.netty.client.Host> hostStream)