Modifier and Type	Class and Description
pack-priv static class	LaxConnPool.LeaseRequest<T, C extends ModalCloseable>
pack-priv static class	LaxConnPool.PerRoutePool<T, C extends ModalCloseable>

Modifier and Type	Field and Description
private final ConnPoolListener<T>	connPoolListener
private volatile int	defaultMaxPerRoute
private final DisposalCallback<C>	disposalCallback
private final AtomicBoolean	isShutDown
private final PoolReusePolicy	policy
private final ConcurrentMap<T, LaxConnPool.PerRoutePool<T, C>>	routeToPool
private final TimeValue	timeToLive

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

Method Summary

Modifier and Type	Method and Description
public void	close(final CloseMode How to close the receiver. closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	closeExpired() Implements org.apache.hc.core5.pool.ConnPoolControl.closeExpired.
public void	closeIdle(final TimeValue idleTime) Implements org.apache.hc.core5.pool.ConnPoolControl.closeIdle.
public void	enumAvailable(final Callback<PoolEntry<T, C>> callback)
public void	enumLeased(final Callback<PoolEntry<T, C>> callback)
public int	getDefaultMaxPerRoute() Implements org.apache.hc.core5.pool.ConnPoolControl.getDefaultMaxPerRoute.
public int	getMaxPerRoute(final T route) Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxPerRoute.
public int	getMaxTotal() Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxTotal.
private LaxConnPool.PerRoutePool<T, C>	getPool(final T route)
public Set<T>	getRoutes() Implements org.apache.hc.core5.pool.ConnPoolControl.getRoutes.
public PoolStats	getStats(final T route) Implements org.apache.hc.core5.pool.ConnPoolStats.getStats.
public PoolStats	getTotalStats() Implements org.apache.hc.core5.pool.ConnPoolStats.getTotalStats.
public boolean	isShutdown()
public Future<PoolEntry<T, C>>	lease(final T route of the connection. route, final Object 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`. state, final Timeout request timeout. In case of a timeout the request can get automatically cancelled by the pool. requestTimeout, final FutureCallback<PoolEntry<T, C>> operation completion callback. callback) Implements org.apache.hc.core5.pool.ConnPool.lease. Attempts to lease a connection for the given route and with the given state from the pool.
public Future<PoolEntry<T, C>>	lease(final T route, final Object state)
public void	release(final PoolEntry<T, C> pool entry leased from the pool entry, final boolean flag indicating whether or not the released connection is in a consistent state and is safe for further use. reusable) Implements org.apache.hc.core5.pool.ConnPool.release. Releases the pool entry back to the pool.
public void	setDefaultMaxPerRoute(final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setDefaultMaxPerRoute.
public void	setMaxPerRoute(final T route, final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxPerRoute.
public void	setMaxTotal(final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxTotal.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validatePendingRequests()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

connPoolListener	back to summary
private final ConnPoolListener<T> connPoolListener

defaultMaxPerRoute	back to summary
private volatile int defaultMaxPerRoute

disposalCallback	back to summary
private final DisposalCallback<C> disposalCallback

isShutDown	back to summary
private final AtomicBoolean isShutDown

policy	back to summary
private final PoolReusePolicy policy

routeToPool	back to summary
private final ConcurrentMap<T, LaxConnPool.PerRoutePool<T, C>> routeToPool

timeToLive	back to summary
private final TimeValue timeToLive

LaxConnPool	back to summary
public LaxConnPool(final int defaultMaxPerRoute, final TimeValue timeToLive, final PoolReusePolicy policy, final DisposalCallback<C> disposalCallback, final ConnPoolListener<T> connPoolListener) Since 5.0

LaxConnPool	back to summary
public LaxConnPool(final int defaultMaxPerRoute, final TimeValue timeToLive, final PoolReusePolicy policy, final ConnPoolListener<T> connPoolListener) Since 5.0

LaxConnPool	back to summary
public LaxConnPool(final int defaultMaxPerRoute)

Method Detail

close	back to summary
public void close(final CloseMode closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Doc from org.apache.hc.core5.io.ModalCloseable.close. 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. Parameters closeMode:CloseMode How to close the receiver. Annotations @Override

back to summary

public void close(final CloseMode closeMode)

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

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.

Parameters

closeMode:CloseMode: How to close the receiver.

Annotations

@Override

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

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

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

closeExpired	back to summary
public void closeExpired() Implements org.apache.hc.core5.pool.ConnPoolControl.closeExpired. Annotations @Override

closeExpired

back to summary

public void closeExpired()

Implements org.apache.hc.core5.pool.ConnPoolControl.closeExpired.

Annotations

@Override

closeIdle	back to summary
public void closeIdle(final TimeValue idleTime) Implements org.apache.hc.core5.pool.ConnPoolControl.closeIdle. Annotations @Override

closeIdle

back to summary

public void closeIdle(final TimeValue idleTime)

Implements org.apache.hc.core5.pool.ConnPoolControl.closeIdle.

Annotations

@Override

enumAvailable	back to summary
public void enumAvailable(final Callback<PoolEntry<T, C>> callback)

enumLeased	back to summary
public void enumLeased(final Callback<PoolEntry<T, C>> callback)

getDefaultMaxPerRoute	back to summary
public int getDefaultMaxPerRoute() Implements org.apache.hc.core5.pool.ConnPoolControl.getDefaultMaxPerRoute. Annotations @Override

getDefaultMaxPerRoute

back to summary

public int getDefaultMaxPerRoute()

Implements org.apache.hc.core5.pool.ConnPoolControl.getDefaultMaxPerRoute.

Annotations

@Override

getMaxPerRoute	back to summary
public int getMaxPerRoute(final T route) Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxPerRoute. Annotations @Override

getMaxPerRoute

back to summary

public int getMaxPerRoute(final T route)

Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxPerRoute.

Annotations

@Override

getMaxTotal	back to summary
public int getMaxTotal() Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxTotal. Annotations @Override

getMaxTotal

back to summary

public int getMaxTotal()

Implements org.apache.hc.core5.pool.ConnPoolControl.getMaxTotal.

Annotations

@Override

getPool	back to summary
private LaxConnPool.PerRoutePool<T, C> getPool(final T route)

getRoutes	back to summary
public Set<T> getRoutes() Implements org.apache.hc.core5.pool.ConnPoolControl.getRoutes. Annotations @Override

getRoutes

back to summary

public Set<T> getRoutes()

Implements org.apache.hc.core5.pool.ConnPoolControl.getRoutes.

Annotations

@Override

getStats	back to summary
public PoolStats getStats(final T route) Implements org.apache.hc.core5.pool.ConnPoolStats.getStats. Annotations @Override

getStats

back to summary

public PoolStats getStats(final T route)

Implements org.apache.hc.core5.pool.ConnPoolStats.getStats.

Annotations

@Override

getTotalStats	back to summary
public PoolStats getTotalStats() Implements org.apache.hc.core5.pool.ConnPoolStats.getTotalStats. Annotations @Override

getTotalStats

back to summary

public PoolStats getTotalStats()

Implements org.apache.hc.core5.pool.ConnPoolStats.getTotalStats.

Annotations

@Override

isShutdown	back to summary
public boolean isShutdown()

lease back to summary

lease	back to summary
public Future<PoolEntry<T, C>> lease(final T route, final Object state, final Timeout requestTimeout, final FutureCallback<PoolEntry<T, C>> callback) Implements org.apache.hc.core5.pool.ConnPool.lease. Doc from org.apache.hc.core5.pool.ConnPool.lease. Attempts to lease a connection for the given route and with the given state from the pool. Please note the connection request can get automatically cancelled by the pool in case of a request timeout. Parameters route:T route of the connection. state:Object 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:Timeout request timeout. In case of a timeout the request can get automatically cancelled by the pool. callback:FutureCallback<PoolEntry<T, C>> operation completion callback. Returns:Future<PoolEntry<T, C>> future for a leased pool entry. Annotations @Override

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

Implements org.apache.hc.core5.pool.ConnPool.lease.

Doc from org.apache.hc.core5.pool.ConnPool.lease.

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

Please note the connection request can get automatically cancelled by the pool in case of a request timeout.

Parameters

route:T: route of the connection.
state:Object: 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:Timeout: request timeout. In case of a timeout the request can get automatically cancelled by the pool.
callback:FutureCallback<PoolEntry<T, C>>: operation completion callback.

Returns:Future<PoolEntry<T, C>>

future for a leased pool entry.

Annotations

@Override

lease	back to summary
public Future<PoolEntry<T, C>> lease(final T route, final Object state)

release	back to summary
public void release(final PoolEntry<T, C> entry, final boolean reusable) Implements org.apache.hc.core5.pool.ConnPool.release. Doc from org.apache.hc.core5.pool.ConnPool.release. Releases the pool entry back to the pool. Parameters entry:PoolEntry<T, C> pool entry leased from the pool reusable:boolean flag indicating whether or not the released connection is in a consistent state and is safe for further use. Annotations @Override

release

back to summary

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

Implements org.apache.hc.core5.pool.ConnPool.release.

Doc from org.apache.hc.core5.pool.ConnPool.release.

Releases the pool entry back to the pool.

Parameters

entry:PoolEntry<T, C>: pool entry leased from the pool
reusable:boolean: flag indicating whether or not the released connection is in a consistent state and is safe for further use.

Annotations

@Override

setDefaultMaxPerRoute	back to summary
public void setDefaultMaxPerRoute(final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setDefaultMaxPerRoute. Annotations @Override

setDefaultMaxPerRoute

back to summary

public void setDefaultMaxPerRoute(final int max)

Implements org.apache.hc.core5.pool.ConnPoolControl.setDefaultMaxPerRoute.

Annotations

@Override

setMaxPerRoute	back to summary
public void setMaxPerRoute(final T route, final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxPerRoute. Annotations @Override

setMaxPerRoute

back to summary

public void setMaxPerRoute(final T route, final int max)

Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxPerRoute.

Annotations

@Override

setMaxTotal	back to summary
public void setMaxTotal(final int max) Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxTotal. Annotations @Override

setMaxTotal

back to summary

public void setMaxTotal(final int max)

Implements org.apache.hc.core5.pool.ConnPoolControl.setMaxTotal.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

validatePendingRequests	back to summary
public void validatePendingRequests()

org.apache.hc.core5.pool back to summary

pack-priv Class LaxConnPool.LeaseRequest<T, C extends org.apache.hc.core5.io.ModalCloseable>

Class Inheritance

extends Object
implements Cancellable

java.lang.Object
org.apache.hc.core5.pool.LaxConnPool.LeaseRequest

All Implemented Interfaces

org.apache.hc.core5.concurrent.Cancellable

Field Summary

Modifier and Type	Field and Description
private final Deadline	deadline
private final BasicFuture<PoolEntry<T, C>>	future
private final Object	state

Constructor Summary

Access	Constructor and Description
pack-priv	LeaseRequest(final Object state, final Timeout requestTimeout, final BasicFuture<PoolEntry<T, C>> future)

Method Summary

Modifier and Type	Method and Description
public boolean	cancel() Implements org.apache.hc.core5.concurrent.Cancellable.cancel. Cancels the ongoing operation or process.
public boolean	completed(final PoolEntry<T, C> result)
public boolean	failed(final Exception ex)
public Deadline	getDeadline()
pack-priv BasicFuture<PoolEntry<T, C>>	getFuture()
public Object	getState()
public boolean	isDone()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

deadline	back to summary
private final Deadline deadline

future	back to summary
private final BasicFuture<PoolEntry<T, C>> future

state	back to summary
private final Object state

Constructor Detail

LeaseRequest	back to summary
pack-priv LeaseRequest(final Object state, final Timeout requestTimeout, final BasicFuture<PoolEntry<T, C>> future)

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel() Implements org.apache.hc.core5.concurrent.Cancellable.cancel. Doc from org.apache.hc.core5.concurrent.Cancellable.cancel. Cancels the ongoing operation or process. Returns:boolean `true` if the operation or process has been cancelled as a result of this method call or `false` if it has already been cancelled or not started. Annotations @Override

public boolean cancel()

Implements org.apache.hc.core5.concurrent.Cancellable.cancel.

Doc from org.apache.hc.core5.concurrent.Cancellable.cancel.

Cancels the ongoing operation or process.

Returns:boolean

true if the operation or process has been cancelled as a result of this method call or false if it has already been cancelled or not started.

Annotations

@Override

completed	back to summary
public boolean completed(final PoolEntry<T, C> result)

failed	back to summary
public boolean failed(final Exception ex)

getDeadline	back to summary
public Deadline getDeadline()

getFuture	back to summary
pack-priv BasicFuture<PoolEntry<T, C>> getFuture()

getState	back to summary
public Object getState()

isDone	back to summary
public boolean isDone()

org.apache.hc.core5.pool back to summary

pack-priv Class LaxConnPool.PerRoutePool<T, C extends org.apache.hc.core5.io.ModalCloseable>

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.core5.pool.LaxConnPool.PerRoutePool

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	LaxConnPool.PerRoutePool.RequestServiceStrategy

Field Summary

Modifier and Type	Field and Description
private final AtomicInteger	allocated
private final Deque<AtomicMarkableReference<PoolEntry<T, C>>>	available
private final ConnPoolListener<T>	connPoolListener
private final ConnPoolStats<T>	connPoolStats
private final DisposalCallback<C>	disposalCallback
private final ConcurrentMap<PoolEntry<T, C>, Boolean>	leased
private volatile int	max
private final Deque<LaxConnPool.LeaseRequest<T, C>>	pending
private final PoolReusePolicy	policy
private final AtomicLong	releaseSeqNum
private final T	route
private final AtomicBoolean	terminated
private final TimeValue	timeToLive

Constructor Summary

Access	Constructor and Description
pack-priv	PerRoutePool(final T route, final int max, final TimeValue timeToLive, final PoolReusePolicy policy, final ConnPoolStats<T> connPoolStats, final DisposalCallback<C> disposalCallback, final ConnPoolListener<T> connPoolListener)

Method Summary

Modifier and Type	Method and Description
private void	addLeased(final PoolEntry<T, C> entry)
private PoolEntry<T, C>	createPoolEntry()
private void	deallocatePoolEntry()
public void	enumAvailable(final Callback<PoolEntry<T, C>> callback)
public void	enumLeased(final Callback<PoolEntry<T, C>> callback)
public int	getAvailableCount()
private PoolEntry<T, C>	getAvailableEntry(final Object state)
public int	getLeasedCount()
public int	getMax()
public int	getPendingCount()
public final T	getRoute()
public Future<PoolEntry<T, C>>	lease(final Object state, final Timeout requestTimeout, final FutureCallback<PoolEntry<T, C>> callback)
public void	release(final PoolEntry<T, C> releasedEntry, final boolean reusable)
private void	removeLeased(final PoolEntry<T, C> entry)
private void	servicePendingRequest()
private void	servicePendingRequests(final LaxConnPool.PerRoutePool.RequestServiceStrategy serviceStrategy)
public void	setMax(final int max)
public void	shutdown(final CloseMode closeMode)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validatePendingRequests()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

allocated	back to summary
private final AtomicInteger allocated

available	back to summary
private final Deque<AtomicMarkableReference<PoolEntry<T, C>>> available

connPoolListener	back to summary
private final ConnPoolListener<T> connPoolListener

connPoolStats	back to summary
private final ConnPoolStats<T> connPoolStats

disposalCallback	back to summary
private final DisposalCallback<C> disposalCallback

leased	back to summary
private final ConcurrentMap<PoolEntry<T, C>, Boolean> leased

max	back to summary
private volatile int max

pending	back to summary
private final Deque<LaxConnPool.LeaseRequest<T, C>> pending

policy	back to summary
private final PoolReusePolicy policy

releaseSeqNum	back to summary
private final AtomicLong releaseSeqNum

route	back to summary
private final T route

terminated	back to summary
private final AtomicBoolean terminated

timeToLive	back to summary
private final TimeValue timeToLive

Constructor Detail

PerRoutePool	back to summary
pack-priv PerRoutePool(final T route, final int max, final TimeValue timeToLive, final PoolReusePolicy policy, final ConnPoolStats<T> connPoolStats, final DisposalCallback<C> disposalCallback, final ConnPoolListener<T> connPoolListener)

Method Detail

addLeased	back to summary
private void addLeased(final PoolEntry<T, C> entry)

createPoolEntry	back to summary
private PoolEntry<T, C> createPoolEntry()

deallocatePoolEntry	back to summary
private void deallocatePoolEntry()

enumAvailable	back to summary
public void enumAvailable(final Callback<PoolEntry<T, C>> callback)

enumLeased	back to summary
public void enumLeased(final Callback<PoolEntry<T, C>> callback)

getAvailableCount	back to summary
public int getAvailableCount()

getAvailableEntry	back to summary
private PoolEntry<T, C> getAvailableEntry(final Object state)

getLeasedCount	back to summary
public int getLeasedCount()

getMax	back to summary
public int getMax()

getPendingCount	back to summary
public int getPendingCount()

getRoute	back to summary
public final T getRoute()

lease	back to summary
public Future<PoolEntry<T, C>> lease(final Object state, final Timeout requestTimeout, final FutureCallback<PoolEntry<T, C>> callback)

release	back to summary
public void release(final PoolEntry<T, C> releasedEntry, final boolean reusable)

removeLeased	back to summary
private void removeLeased(final PoolEntry<T, C> entry)

servicePendingRequest	back to summary
private void servicePendingRequest()

servicePendingRequests	back to summary
private void servicePendingRequests(final LaxConnPool.PerRoutePool.RequestServiceStrategy serviceStrategy)

setMax	back to summary
public void setMax(final int max)

shutdown	back to summary
public void shutdown(final CloseMode closeMode)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

validatePendingRequests	back to summary
public void validatePendingRequests()

org.apache.hc.core5.pool back to summary

private final Enum LaxConnPool.PerRoutePool.RequestServiceStrategy

Class Inheritance

extends Enum<LaxConnPool.PerRoutePool.RequestServiceStrategy>

java.lang.Object
java.lang.Enum
org.apache.hc.core5.pool.LaxConnPool.PerRoutePool.RequestServiceStrategy

Field Summary

Modifier and Type	Field and Description
public static final LaxConnPool.PerRoutePool.RequestServiceStrategy	ALL
public static final LaxConnPool.PerRoutePool.RequestServiceStrategy	FIRST_SUCCESSFUL

Constructor Summary

Access	Constructor and Description
private	RequestServiceStrategy()

Method Summary

Modifier and Type	Method and Description
public static LaxConnPool.PerRoutePool.RequestServiceStrategy	valueOf(String name)
public static LaxConnPool.PerRoutePool.RequestServiceStrategy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL	back to summary
public static final LaxConnPool.PerRoutePool.RequestServiceStrategy ALL

FIRST_SUCCESSFUL	back to summary
public static final LaxConnPool.PerRoutePool.RequestServiceStrategy FIRST_SUCCESSFUL

Constructor Detail

RequestServiceStrategy	back to summary
private RequestServiceStrategy()

Method Detail

valueOf	back to summary
public static LaxConnPool.PerRoutePool.RequestServiceStrategy valueOf(String name)

values	back to summary
public static LaxConnPool.PerRoutePool.RequestServiceStrategy[] values()

public Class LaxConnPool<T, C extends org.apache.hc.core5.io.ModalCloseable>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class LaxConnPool.LeaseRequest<T, C extends org.apache.hc.core5.io.ModalCloseable>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class LaxConnPool.PerRoutePool<T, C extends org.apache.hc.core5.io.ModalCloseable>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum LaxConnPool.PerRoutePool.RequestServiceStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail