io.reactivex.netty.protocol.tcp.client

Class TcpClient<W,R>

java.lang.Object

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

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

Type Parameters:

W - The type of objects written to this client.

R - The type of objects read from this client.

All Implemented Interfaces:

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

Direct Known Subclasses:

TcpClientImpl

public abstract class TcpClient<W,R>
extends InterceptingTcpClient<W,R>

A TCP client for creating TCP connections.

Immutability

An instance of this client is immutable and all mutations produce a new client instance. For this reason it is recommended that the mutations are done during client creation and not during connection creation to avoid repeated object creation overhead.

Constructor Summary

Constructors

Constructor and Description
TcpClient()

Method Summary

Modifier and Type	Method and Description
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract <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.
abstract 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.
abstract 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.
static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newClient(io.reactivex.netty.client.ConnectionProviderFactory<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> providerFactory, rx.Observable<io.reactivex.netty.client.Host> hostStream) Creates a new TCP client instance using the supplied connection provider.
static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newClient(java.net.SocketAddress serverAddress) Creates a new TCP client instance with the passed address of the target server.
static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newClient(java.lang.String host, int port) Creates a new TCP client instance with the passed address of the target server.
abstract <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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.InterceptingTcpClient

createConnectionRequest, intercept

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.netty.events.EventSource

subscribe

Constructor Detail

TcpClient

public TcpClient()

Method Detail

channelOption

public abstract <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.

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpClient instance.

readTimeOut

public abstract 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.

Parameters:

timeOut - Read timeout duration.

timeUnit - Read timeout time unit.

Returns:

A new TcpClient instance.

addChannelHandlerFirst

public abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerFirst

public abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpClient instance.

addChannelHandlerLast

public abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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. 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 pipelineConfigurator(Action1) will be more convenient.

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 abstract <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.

Parameters:

pipelineConfigurator - Action to configure ChannelPipeline.

Returns:

A new TcpClient instance.

enableWireLogging

public abstract 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.

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 abstract 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. If the SSLEngine instance can be statically, created, secure(SSLEngine) can be used.

Parameters:

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

Returns:

A new TcpClient instance.

secure

public abstract 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. If the SSLEngine instance can not be statically, created, secure(Func1) )} can be used.

Parameters:

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

Returns:

A new TcpClient instance.

secure

public abstract 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. This is required only when the SslHandler used by SslCodec is to be modified before adding to the ChannelPipeline. For most of the cases, secure(Func1) or secure(SSLEngine) will be enough.

Parameters:

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

Returns:

A new TcpClient instance.

unsafeSecure

public abstract 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. This is only for testing and should not be used for real production clients.

Returns:

A new TcpClient instance.

channelProvider

public abstract 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.

Parameters:

providerFactory - Channel provider factory.

Returns:

A new TcpClient instance.

newClient

public static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(java.lang.String host,
                                                                                   int port)

Creates a new TCP client instance with the passed address of the target server.

Parameters:

host - Hostname for the target server.

port - Port for the target server.

Returns:

A new TcpClient instance.

newClient

public static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(java.net.SocketAddress serverAddress)

Creates a new TCP client instance with the passed address of the target server.

Parameters:

serverAddress - Socket address for the target server.

Returns:

A new TcpClient instance.

newClient

public static TcpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(io.reactivex.netty.client.ConnectionProviderFactory<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> providerFactory,
                                                                                   rx.Observable<io.reactivex.netty.client.Host> hostStream)

Creates a new TCP client instance using the supplied connection provider.

Parameters:

providerFactory - ConnectionProviderFactory for the client.

hostStream - Stream of hosts for the client.

Returns:

A new TcpClient instance.