org.apache.hc.core5.pool

Class LaxConnPool<T,C extends ModalCloseable>

java.lang.Object

org.apache.hc.core5.pool.LaxConnPool<T,C>

Type Parameters:

T - route

C - connection object

All Implemented Interfaces:

Closeable, AutoCloseable, ModalCloseable, ConnPool<T,C>, ConnPoolControl<T>, ConnPoolStats<T>, ManagedConnPool<T,C>

@Contract(threading=SAFE)
 @Experimental
public class LaxConnPool<T,C extends ModalCloseable>
extends Object
implements ManagedConnPool<T,C>

Connection pool with higher concurrency but with lax connection limit guarantees.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
LaxConnPool(int defaultMaxPerRoute)
LaxConnPool(int defaultMaxPerRoute, TimeValue timeToLive, PoolReusePolicy policy, ConnPoolListener<T> connPoolListener)
LaxConnPool(int defaultMaxPerRoute, TimeValue timeToLive, PoolReusePolicy policy, DisposalCallback<C> disposalCallback, ConnPoolListener<T> connPoolListener)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream and releases any system resources associated with it.
void	close(CloseMode closeMode) Closes this process or endpoint and releases any system resources associated with it.
void	closeExpired()
void	closeIdle(TimeValue idleTime)
void	enumAvailable(Callback<PoolEntry<T,C>> callback)
void	enumLeased(Callback<PoolEntry<T,C>> callback)
int	getDefaultMaxPerRoute()
int	getMaxPerRoute(T route)
int	getMaxTotal()
Set<T>	getRoutes()
PoolStats	getStats(T route)
PoolStats	getTotalStats()
boolean	isShutdown()
Future<PoolEntry<T,C>>	lease(T route, Object state)
Future<PoolEntry<T,C>>	lease(T route, Object state, Timeout requestTimeout, FutureCallback<PoolEntry<T,C>> callback) Attempts to lease a connection for the given route and with the given state from the pool.
void	release(PoolEntry<T,C> entry, boolean reusable) Releases the pool entry back to the pool.
void	setDefaultMaxPerRoute(int max)
void	setMaxPerRoute(T route, int max)
void	setMaxTotal(int max)
String	toString() Returns a string representation of the object.
void	validatePendingRequests()

Methods inherited from class java.lang.Object

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

Constructor Detail

LaxConnPool

public LaxConnPool(int defaultMaxPerRoute)

LaxConnPool

public LaxConnPool(int defaultMaxPerRoute,
                   TimeValue timeToLive,
                   PoolReusePolicy policy,
                   ConnPoolListener<T> connPoolListener)

Since:

5.0

LaxConnPool

public LaxConnPool(int defaultMaxPerRoute,
                   TimeValue timeToLive,
                   PoolReusePolicy policy,
                   DisposalCallback<C> disposalCallback,
                   ConnPoolListener<T> connPoolListener)

Since:

5.0

Method Detail

close

public void close()

Description copied from interface: Closeable

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public void close(CloseMode closeMode)

Description copied from interface: ModalCloseable

Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.

Specified by:

close in interface ModalCloseable

Parameters:

closeMode - How to close the receiver.

closeExpired

public void closeExpired()

Specified by:

closeExpired in interface ConnPoolControl<T>

closeIdle

public void closeIdle(TimeValue idleTime)

Specified by:

closeIdle in interface ConnPoolControl<T>

enumAvailable

public void enumAvailable(Callback<PoolEntry<T,C>> callback)

enumLeased

public void enumLeased(Callback<PoolEntry<T,C>> callback)

getDefaultMaxPerRoute

public int getDefaultMaxPerRoute()

Specified by:

getDefaultMaxPerRoute in interface ConnPoolControl<T>

getMaxPerRoute

public int getMaxPerRoute(T route)

Specified by:

getMaxPerRoute in interface ConnPoolControl<T>

getMaxTotal

public int getMaxTotal()

Specified by:

getMaxTotal in interface ConnPoolControl<T>

getRoutes

public Set<T> getRoutes()

Specified by:

getRoutes in interface ConnPoolControl<T>

getStats

public PoolStats getStats(T route)

Specified by:

getStats in interface ConnPoolStats<T>

getTotalStats

public PoolStats getTotalStats()

Specified by:

getTotalStats in interface ConnPoolStats<T>

isShutdown

public boolean isShutdown()

lease

public Future<PoolEntry<T,C>> lease(T route,
                                    Object state)

lease

public Future<PoolEntry<T,C>> lease(T route,
                                    Object state,
                                    Timeout requestTimeout,
                                    FutureCallback<PoolEntry<T,C>> callback)

Description copied from interface: ConnPool

Attempts to lease a connection for the given route and with the given state from the pool.

Specified by:

lease in interface ConnPool<T,C extends ModalCloseable>

Parameters:

route - route of the connection.

state - arbitrary object that represents a particular state (usually a security principal or a unique token identifying the user whose credentials have been used while establishing the connection). May be null.

requestTimeout - request timeout.

callback - operation completion callback.

Returns:

future for a leased pool entry.

release

public void release(PoolEntry<T,C> entry,
                    boolean reusable)

Description copied from interface: ConnPool

Releases the pool entry back to the pool.

Specified by:

release in interface ConnPool<T,C extends ModalCloseable>

Parameters:

entry - pool entry leased from the pool

reusable - flag indicating whether or not the released connection is in a consistent state and is safe for further use.

setDefaultMaxPerRoute

public void setDefaultMaxPerRoute(int max)

Specified by:

setDefaultMaxPerRoute in interface ConnPoolControl<T>

setMaxPerRoute

public void setMaxPerRoute(T route,
                           int max)

Specified by:

setMaxPerRoute in interface ConnPoolControl<T>

setMaxTotal

public void setMaxTotal(int max)

Specified by:

setMaxTotal in interface ConnPoolControl<T>

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

validatePendingRequests

public void validatePendingRequests()