io.reactivex.netty.client

Class PooledConnection<I,O>

java.lang.Object

io.reactivex.netty.channel.DefaultChannelWriter<O>

io.reactivex.netty.channel.ObservableConnection<I,O>

io.reactivex.netty.client.PooledConnection<I,O>

Type Parameters:

I - The type of the object that is read from this connection.

O - The type of objects that are written to this connection.

All Implemented Interfaces:

ChannelWriter<O>

public class PooledConnection<I,O>
extends ObservableConnection<I,O>

An extension of ObservableConnection that is used by ConnectionPool. The pool using this connection must call setConnectionPool(ConnectionPool) before using the instance. Failure to do so will never return this connection to the pool and the close() will dispose this connection.

Field Summary

Fields inherited from class io.reactivex.netty.channel.ObservableConnection

closeStartTimeMillis

Fields inherited from class io.reactivex.netty.channel.DefaultChannelWriter

closeIssued, CONNECTION_ALREADY_CLOSED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PooledConnection(io.netty.channel.Channel channel, long maxIdleTimeMillis, ChannelMetricEventProvider metricEventProvider, MetricEventsSubject<?> eventsSubject)

Method Summary

Modifier and Type	Method and Description
protected rx.Observable<java.lang.Void>	_closeChannel()
void	beforeReuse()
rx.Observable<java.lang.Void>	close() Closes this connection.
rx.Observable<java.lang.Void>	closeUnderlyingChannel()
static <I,O> PooledConnection<I,O>	create(io.netty.channel.Channel channel, ChannelMetricEventProvider metricEventProvider, MetricEventsSubject<?> eventsSubject)
static <I,O> PooledConnection<I,O>	create(io.netty.channel.Channel channel, long maxIdleTimeMillis, ChannelMetricEventProvider metricEventProvider, MetricEventsSubject<?> eventsSubject)
boolean	isUsable() Returns whether this connection is safe to be used at this moment.
void	setConnectionPool(ConnectionPool<I,O> pool)
void	updateMaxIdleTimeMillis(long maxIdleTimeMillis)

Methods inherited from class io.reactivex.netty.channel.ObservableConnection

_close, create, fireNewRxConnectionEvent, getInput, updateInputSubject

Methods inherited from class io.reactivex.netty.channel.DefaultChannelWriter

cancelPendingWrites, close, flush, getAllocator, getChannel, isCloseIssued, write, write, writeAndFlush, writeAndFlush, writeBytes, writeBytes, writeBytesAndFlush, writeBytesAndFlush, writeFileRegion, writeOnChannel, writeString, writeStringAndFlush

Methods inherited from class java.lang.Object

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

Constructor Detail

PooledConnection

protected PooledConnection(io.netty.channel.Channel channel,
                           long maxIdleTimeMillis,
                           ChannelMetricEventProvider metricEventProvider,
                           MetricEventsSubject<?> eventsSubject)

Method Detail

setConnectionPool

public void setConnectionPool(ConnectionPool<I,O> pool)

close

public rx.Observable<java.lang.Void> close()

Description copied from class: ObservableConnection

Closes this connection. This method is idempotent, so it can be called multiple times without any side-effect on the channel.
This will also cancel any pending writes on the underlying channel.

Specified by:

close in interface ChannelWriter<O>

Overrides:

close in class ObservableConnection<I,O>

Returns:

Observable signifying the close on the connection. Returns Observable.error(Throwable) if the close is already issued (may not be completed)

_closeChannel

protected rx.Observable<java.lang.Void> _closeChannel()

Overrides:

_closeChannel in class ObservableConnection<I,O>

closeUnderlyingChannel

public rx.Observable<java.lang.Void> closeUnderlyingChannel()

isUsable

public boolean isUsable()

Returns whether this connection is safe to be used at this moment.
This makes sure that the underlying netty's channel is active as returned by Channel.isActive() and it has not passed the maximum idle time in the pool.

Returns:

true if the connection is usable.

beforeReuse

public void beforeReuse()

updateMaxIdleTimeMillis

public void updateMaxIdleTimeMillis(long maxIdleTimeMillis)

create

public static <I,O> PooledConnection<I,O> create(io.netty.channel.Channel channel,
                                                 long maxIdleTimeMillis,
                                                 ChannelMetricEventProvider metricEventProvider,
                                                 MetricEventsSubject<?> eventsSubject)

create

public static <I,O> PooledConnection<I,O> create(io.netty.channel.Channel channel,
                                                 ChannelMetricEventProvider metricEventProvider,
                                                 MetricEventsSubject<?> eventsSubject)