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

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

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) Enumerates all available connections.
public void	enumLeased(final Callback<PoolEntry<T, C>> callback) Enumerates all leased connections.
private void	fireCallbacks()
public int	getDefaultMaxPerRoute() Implements org.apache.hc.core5.pool.ConnPoolControl.getDefaultMaxPerRoute.
private int	getMax(final T route)
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 StrictConnPool.PerRoutePool<T, C>	getPool(final T route)
public Set<T>	getRoutes() Implements org.apache.hc.core5.pool.ConnPoolControl.getRoutes. Returns snapshot of all knows routes
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)
private void	processNextPendingRequest()
private boolean	processPendingRequest(final StrictConnPool.LeaseRequest<T, C> request)
private void	processPendingRequests()
private void	purgePoolMap()
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

Field Detail

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

completedRequests	back to summary
private final ConcurrentLinkedQueue<StrictConnPool.LeaseRequest<T, C>> completedRequests

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

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

lock	back to summary
private final Lock lock

maxPerRoute	back to summary
private final Map<T, Integer> maxPerRoute

maxTotal	back to summary
private volatile int maxTotal

pendingRequests	back to summary
private final LinkedList<StrictConnPool.LeaseRequest<T, C>> pendingRequests

policy	back to summary
private final PoolReusePolicy policy

routeToPool	back to summary
private final Map<T, StrictConnPool.PerRoutePool<T, C>> routeToPool

timeToLive	back to summary
private final TimeValue timeToLive

Constructor Detail

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

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

StrictConnPool	back to summary
public StrictConnPool(final int defaultMaxPerRoute, final int maxTotal)

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) Enumerates all available connections. Since 4.3

enumAvailable

back to summary

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

Enumerates all available connections.

Since: 4.3

enumLeased	back to summary
public void enumLeased(final Callback<PoolEntry<T, C>> callback) Enumerates all leased connections. Since 4.3

enumLeased

back to summary

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

Enumerates all leased connections.

Since: 4.3

fireCallbacks	back to summary
private void fireCallbacks()

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

getMax	back to summary
private int getMax(final T route)

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 StrictConnPool.PerRoutePool<T, C> getPool(final T route)

getRoutes	back to summary
public Set<T> getRoutes() Implements org.apache.hc.core5.pool.ConnPoolControl.getRoutes. Returns snapshot of all knows routes Annotations @Override Since 4.4

getRoutes

back to summary

public Set<T> getRoutes()

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

Returns snapshot of all knows routes

Annotations

@Override

Since

4.4

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)

processNextPendingRequest	back to summary
private void processNextPendingRequest()

processPendingRequest	back to summary
private boolean processPendingRequest(final StrictConnPool.LeaseRequest<T, C> request)

processPendingRequests	back to summary
private void processPendingRequests()

purgePoolMap	back to summary
private void purgePoolMap()

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 StrictConnPool.LeaseRequest<T, C extends org.apache.hc.core5.io.ModalCloseable>

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private final AtomicBoolean	completed
private final Deadline	deadline
private volatile Exception	ex
private final BasicFuture<PoolEntry<T, C>>	future
private volatile PoolEntry<T, C>	result
private final T	route
private final Object	state

Constructor Summary

Access	Constructor and Description
public	LeaseRequest(final T route route, final Object state state, final Timeout timeout to wait in a request queue until kicked off requestTimeout, final BasicFuture<PoolEntry<T, C>> future callback future) Constructor

Method Summary

Modifier and Type	Method and Description
public void	completed(final PoolEntry<T, C> result)
public void	failed(final Exception ex)
public Deadline	getDeadline()
public Exception	getException()
public BasicFuture<PoolEntry<T, C>>	getFuture()
public PoolEntry<T, C>	getResult()
public T	getRoute()
public Object	getState()
public boolean	isDone()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

completed	back to summary
private final AtomicBoolean completed

deadline	back to summary
private final Deadline deadline

ex	back to summary
private volatile Exception ex

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

result	back to summary
private volatile PoolEntry<T, C> result

route	back to summary
private final T route

state	back to summary
private final Object state

Constructor Detail

LeaseRequest

back to summary

public LeaseRequest(final T route, final Object state, final Timeout requestTimeout, final BasicFuture<PoolEntry<T, C>> future)

Constructor

Parameters

route:T: route
state:Object: state
requestTimeout:Timeout: timeout to wait in a request queue until kicked off
future:BasicFuture<PoolEntry<T, C>>: future callback

Method Detail

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

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

getDeadline	back to summary
public Deadline getDeadline()

getException	back to summary
public Exception getException()

getFuture	back to summary
public BasicFuture<PoolEntry<T, C>> getFuture()

getResult	back to summary
public PoolEntry<T, C> getResult()

getRoute	back to summary
public T getRoute()

getState	back to summary
public Object getState()

isDone	back to summary
public boolean isDone()

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

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

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

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private final LinkedList<PoolEntry<T, C>>	available
private final DisposalCallback<C>	disposalCallback
private final Set<PoolEntry<T, C>>	leased
private final T	route

Constructor Summary

Access	Constructor and Description
pack-priv	PerRoutePool(final T route, final DisposalCallback<C> disposalCallback)

Method Summary

Modifier and Type	Method and Description
public PoolEntry<T, C>	createEntry(final TimeValue timeToLive)
public void	free(final PoolEntry<T, C> entry, final boolean reusable)
public int	getAllocatedCount()
public int	getAvailableCount()
public PoolEntry<T, C>	getFree(final Object state)
public PoolEntry<T, C>	getLastUsed()
public int	getLeasedCount()
public final T	getRoute()
public boolean	remove(final PoolEntry<T, C> entry)
public void	shutdown(final CloseMode closeMode)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

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

disposalCallback	back to summary
private final DisposalCallback<C> disposalCallback

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

route	back to summary
private final T route

Constructor Detail

PerRoutePool	back to summary
pack-priv PerRoutePool(final T route, final DisposalCallback<C> disposalCallback)

Method Detail

createEntry	back to summary
public PoolEntry<T, C> createEntry(final TimeValue timeToLive)

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

getAllocatedCount	back to summary
public int getAllocatedCount()

getAvailableCount	back to summary
public int getAvailableCount()

getFree	back to summary
public PoolEntry<T, C> getFree(final Object state)

getLastUsed	back to summary
public PoolEntry<T, C> getLastUsed()

getLeasedCount	back to summary
public int getLeasedCount()

getRoute	back to summary
public final T getRoute()

remove	back to summary
public boolean remove(final PoolEntry<T, C> entry)

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

public Class StrictConnPool<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 StrictConnPool.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 StrictConnPool.PerRoutePool<T, C extends org.apache.hc.core5.io.ModalCloseable>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail