io.reactivex.netty.client.pool

Class IdleConnectionsHolder<W,R>

java.lang.Object

io.reactivex.netty.client.pool.IdleConnectionsHolder<W,R>

Type Parameters:

W - Type of object that is written to the client using this holder.

R - Type of object that is read from the the client using this holder.

Direct Known Subclasses:

FIFOIdleConnectionsHolder, PreferCurrentEventLoopHolder

public abstract class IdleConnectionsHolder<W,R>
extends java.lang.Object

A holder of idle PooledConnection used by PooledConnectionProvider

Constructor Summary

Constructors

Constructor and Description
IdleConnectionsHolder()

Method Summary

Modifier and Type	Method and Description
abstract void	add(PooledConnection<R,W> toAdd) Adds the passed connection to this holder.
abstract rx.Observable<PooledConnection<R,W>>	peek() Creates a stream of idle connections where every item sent on to the stream is NOT removed from the underlying idle connections pool.
abstract rx.Observable<PooledConnection<R,W>>	poll() Creates a stream of idle connections where every item sent on to the stream is removed from the underlying idle connections pool.
rx.Observable<PooledConnection<R,W>>	pollThisEventLoopConnections() Creates a stream of idle connections where every item sent on to the stream is removed from the underlying idle connections pool.
abstract boolean	remove(PooledConnection<R,W> toRemove) Removes the passed connection from this holder.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdleConnectionsHolder

public IdleConnectionsHolder()

Method Detail

poll

public abstract rx.Observable<PooledConnection<R,W>> poll()

Creates a stream of idle connections where every item sent on to the stream is removed from the underlying idle connections pool.

Returns:

A stream of idle connections.

pollThisEventLoopConnections

public rx.Observable<PooledConnection<R,W>> pollThisEventLoopConnections()

Creates a stream of idle connections where every item sent on to the stream is removed from the underlying idle connections pool. This method will only poll connections if the calling thread is an EventLoop known to this holder. Otherwise, it should return an empty stream.

Returns:

A stream of idle connections.

peek

public abstract rx.Observable<PooledConnection<R,W>> peek()

Creates a stream of idle connections where every item sent on to the stream is NOT removed from the underlying idle connections pool. If the connection is to be removed, remove(PooledConnection) must be called for that connection.

Returns:

A stream of idle connections.

add

public abstract void add(PooledConnection<R,W> toAdd)

Adds the passed connection to this holder.

Parameters:

toAdd - Connection to add.

remove

public abstract boolean remove(PooledConnection<R,W> toRemove)

Removes the passed connection from this holder.

Parameters:

toRemove - Connection to remove.