io.reactivex.netty.client

Class AbstractClientBuilder<I,O,B extends AbstractClientBuilder,C extends RxClient<I,O>>

java.lang.Object

io.reactivex.netty.client.AbstractClientBuilder<I,O,B,C>

Direct Known Subclasses:

ClientBuilder, CompositeHttpClientBuilder, HttpClientBuilder, UdpClientBuilder, WebSocketClientBuilder

public abstract class AbstractClientBuilder<I,O,B extends AbstractClientBuilder,C extends RxClient<I,O>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.bootstrap.Bootstrap	bootstrap
protected ClientChannelFactory<O,I>	channelFactory
protected RxClient.ClientConfig	clientConfig
protected ClientConnectionFactory<O,I,? extends ObservableConnection<O,I>>	connectionFactory
protected MetricEventsListenerFactory	eventListenersFactory
protected io.netty.channel.EventLoopGroup	eventLoopGroup
protected MetricEventsSubject<ClientMetricsEvent<?>>	eventsSubject
protected PipelineConfigurator<O,I>	pipelineConfigurator
protected ConnectionPoolBuilder<O,I>	poolBuilder
protected RxClient.ServerInfo	serverInfo
protected java.lang.Class<? extends io.netty.channel.Channel>	socketChannel
protected io.netty.handler.logging.LogLevel	wireLogginLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClientBuilder(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port, ClientConnectionFactory<O,I,? extends ObservableConnection<O,I>> connectionFactory, ClientChannelFactory<O,I> factory)
protected	AbstractClientBuilder(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port, ConnectionPoolBuilder<O,I> poolBuilder)

Method Summary

Modifier and Type	Method and Description
B	appendPipelineConfigurator(PipelineConfigurator<O,I> additionalConfigurator)
C	build()
B	channel(java.lang.Class<? extends io.netty.channel.Channel> socketChannel)
<T> B	channelOption(io.netty.channel.ChannelOption<T> option, T value)
B	config(RxClient.ClientConfig clientConfig)
protected abstract C	createClient()
B	defaultChannelOptions()
protected io.netty.channel.EventLoopGroup	defaultEventloop(java.lang.Class<? extends io.netty.channel.Channel> socketChannel)
protected java.lang.Class<? extends io.netty.channel.socket.SocketChannel>	defaultSocketChannelClass()
B	defaultTcpOptions()
B	defaultUdpOptions()
B	enableWireLogging(io.netty.handler.logging.LogLevel wireLogginLevel) Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.
B	eventloop(io.netty.channel.EventLoopGroup eventLoopGroup)
protected java.lang.String	generatedNamePrefix()
io.netty.bootstrap.Bootstrap	getBootstrap()
MetricEventsSubject<ClientMetricsEvent<?>>	getEventsSubject()
protected java.lang.String	getOrCreateName()
PipelineConfigurator<O,I>	getPipelineConfigurator()
protected ConnectionPoolBuilder<O,I>	getPoolBuilder(boolean createNew)
RxClient.ServerInfo	getServerInfo()
protected abstract MetricEventsListener<? extends ClientMetricsEvent<? extends java.lang.Enum>>	newMetricsListener(MetricEventsListenerFactory factory, C client)
B	pipelineConfigurator(PipelineConfigurator<O,I> pipelineConfigurator)
protected B	returnBuilder()
B	withChannelFactory(ClientChannelFactory<O,I> factory)
B	withConnectionPoolLimitStrategy(PoolLimitDeterminationStrategy limitDeterminationStrategy)
B	withIdleConnectionsTimeoutMillis(long idleConnectionsTimeoutMillis)
B	withMaxConnections(int maxConnections)
B	withMetricEventsListenerFactory(MetricEventsListenerFactory eventListenersFactory)
B	withName(java.lang.String name)
B	withNoConnectionPooling() Overrides all the connection pool settings done previous to this call and disables connection pooling for this client, unless enabled again after this call returns.
B	withNoIdleConnectionCleanup()
B	withPoolIdleCleanupScheduler(java.util.concurrent.ScheduledExecutorService poolIdleCleanupScheduler)
B	withSslEngineFactory(SSLEngineFactory sslEngineFactory)

Methods inherited from class java.lang.Object

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

Field Detail

serverInfo

protected final RxClient.ServerInfo serverInfo

bootstrap

protected final io.netty.bootstrap.Bootstrap bootstrap

connectionFactory

protected final ClientConnectionFactory<O,I,? extends ObservableConnection<O,I>> connectionFactory

channelFactory

protected ClientChannelFactory<O,I> channelFactory

poolBuilder

protected ConnectionPoolBuilder<O,I> poolBuilder

pipelineConfigurator

protected PipelineConfigurator<O,I> pipelineConfigurator

socketChannel

protected java.lang.Class<? extends io.netty.channel.Channel> socketChannel

eventLoopGroup

protected io.netty.channel.EventLoopGroup eventLoopGroup

clientConfig

protected RxClient.ClientConfig clientConfig

wireLogginLevel

protected io.netty.handler.logging.LogLevel wireLogginLevel

eventListenersFactory

protected MetricEventsListenerFactory eventListenersFactory

eventsSubject

protected MetricEventsSubject<ClientMetricsEvent<?>> eventsSubject

Constructor Detail

AbstractClientBuilder

protected AbstractClientBuilder(io.netty.bootstrap.Bootstrap bootstrap,
                                java.lang.String host,
                                int port,
                                ClientConnectionFactory<O,I,? extends ObservableConnection<O,I>> connectionFactory,
                                ClientChannelFactory<O,I> factory)

AbstractClientBuilder

protected AbstractClientBuilder(io.netty.bootstrap.Bootstrap bootstrap,
                                java.lang.String host,
                                int port,
                                ConnectionPoolBuilder<O,I> poolBuilder)

Method Detail

defaultChannelOptions

public B defaultChannelOptions()

defaultTcpOptions

public B defaultTcpOptions()

defaultUdpOptions

public B defaultUdpOptions()

pipelineConfigurator

public B pipelineConfigurator(PipelineConfigurator<O,I> pipelineConfigurator)

channelOption

public <T> B channelOption(io.netty.channel.ChannelOption<T> option,
                           T value)

channel

public B channel(java.lang.Class<? extends io.netty.channel.Channel> socketChannel)

eventloop

public B eventloop(io.netty.channel.EventLoopGroup eventLoopGroup)

config

public B config(RxClient.ClientConfig clientConfig)

withMaxConnections

public B withMaxConnections(int maxConnections)

withIdleConnectionsTimeoutMillis

public B withIdleConnectionsTimeoutMillis(long idleConnectionsTimeoutMillis)

withConnectionPoolLimitStrategy

public B withConnectionPoolLimitStrategy(PoolLimitDeterminationStrategy limitDeterminationStrategy)

withPoolIdleCleanupScheduler

public B withPoolIdleCleanupScheduler(java.util.concurrent.ScheduledExecutorService poolIdleCleanupScheduler)

withNoIdleConnectionCleanup

public B withNoIdleConnectionCleanup()

getPipelineConfigurator

public PipelineConfigurator<O,I> getPipelineConfigurator()

appendPipelineConfigurator

public B appendPipelineConfigurator(PipelineConfigurator<O,I> additionalConfigurator)

withChannelFactory

public B withChannelFactory(ClientChannelFactory<O,I> factory)

enableWireLogging

public B enableWireLogging(io.netty.handler.logging.LogLevel wireLogginLevel)

Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.
Since, in most of the production systems, the logging level is set to LogLevel.WARN or LogLevel.ERROR, if this wire level logging is required for all requests (not at all recommended as this logging is very verbose), the passed level must be LogLevel.WARN or LogLevel.ERROR respectively.
It is recommended to set this level to LogLevel.DEBUG and then dynamically enabled disable this log level whenever required.

Parameters:

wireLogginLevel - Log level at which the wire level logs will be logged.

Returns:

This builder.

See Also:

LoggingHandler

withName

public B withName(java.lang.String name)

withMetricEventsListenerFactory

public B withMetricEventsListenerFactory(MetricEventsListenerFactory eventListenersFactory)

withNoConnectionPooling

public B withNoConnectionPooling()

Overrides all the connection pool settings done previous to this call and disables connection pooling for this client, unless enabled again after this call returns.

Returns:

This builder.

withSslEngineFactory

public B withSslEngineFactory(SSLEngineFactory sslEngineFactory)

getBootstrap

public io.netty.bootstrap.Bootstrap getBootstrap()

getServerInfo

public RxClient.ServerInfo getServerInfo()

getEventsSubject

public MetricEventsSubject<ClientMetricsEvent<?>> getEventsSubject()

build

public C build()

defaultEventloop

protected io.netty.channel.EventLoopGroup defaultEventloop(java.lang.Class<? extends io.netty.channel.Channel> socketChannel)

defaultSocketChannelClass

protected java.lang.Class<? extends io.netty.channel.socket.SocketChannel> defaultSocketChannelClass()

createClient

protected abstract C createClient()

returnBuilder

protected B returnBuilder()

getPoolBuilder

protected ConnectionPoolBuilder<O,I> getPoolBuilder(boolean createNew)

getOrCreateName

protected java.lang.String getOrCreateName()

generatedNamePrefix

protected java.lang.String generatedNamePrefix()

newMetricsListener

protected abstract MetricEventsListener<? extends ClientMetricsEvent<? extends java.lang.Enum>> newMetricsListener(MetricEventsListenerFactory factory,
                                                                                                                   C client)