Modifier and Type	Class and Description
private static class	AbstractConnectionPool.EntryHolder
private class	AbstractConnectionPool.FutureConnection

Modifier and Type	Field and Description
private final HttpDestination	destination
private volatile int	initialMaxMultiplex
private static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private volatile long	maxDurationNanos
private boolean	maximizeConnections
private volatile int	maxUsage
private final AtomicInteger	pending
private Pool<Connection>	pool
private final Pool.Factory<Connection>	poolFactory

Access	Constructor and Description
protected	AbstractConnectionPool(Destination destination, Pool.Factory<Connection> poolFactory, int initialMaxMultiplex)

Method Summary

Modifier and Type	Method and Description
public boolean	accept(Connection the connection to accept connection) Implements org.eclipse.jetty.client.ConnectionPool.accept. Accepts the given connection to be managed by this ConnectionPool.
public Connection	Returns: an idle connection or `null` if no idle connections are available acquire(boolean a hint to attempt to open a new connection if no idle connections are available create) Implements org.eclipse.jetty.client.ConnectionPool.acquire. Returns an idle connection, if available; if an idle connection is not available, and the given `create` parameter is `true` or `isMaximizeConnections()` is `true`, then attempts to open a new connection, if possible within the configuration of this connection pool (for example, if it does not exceed the max connection count); otherwise it attempts to open a new connection, if the number of queued requests is greater than the number of pending connections; if no connection is available even after the attempts to open, return `null`.
protected void	acquired(Connection connection)
protected Connection	activate()
private void	close(Pool.Entry<Connection> entry)
protected boolean	deactivate(Connection connection)
protected void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public int	getActiveConnectionCount()
pack-priv Collection<Connection>	getActiveConnections()
public int	getConnectionCount()
public int	getIdleConnectionCount()
pack-priv Collection<Connection>	getIdleConnections()
protected int	getInitialMaxMultiplex()
public int	getMaxConnectionCount()
public long	Returns: the max usage duration, in milliseconds, of a pooled connection getMaxDuration() Returns the max usage duration in milliseconds of a pooled connection.
public int	Returns: the max number of times a pooled connection can be used getMaxUsage() Returns the max number of times a pooled connection can be used.
public int	getPendingConnectionCount()
protected boolean	idle(Connection connection, boolean close)
public boolean	isActive(Connection the connection to test connection) Implements org.eclipse.jetty.client.ConnectionPool.isActive.
public boolean	isEmpty() Implements org.eclipse.jetty.client.ConnectionPool.isEmpty.
public boolean	isMaximizeConnections()
protected void	onCreated(Connection connection)
public CompletableFuture<Void>	preCreateConnections(int the number of connections to pre-start. connectionCount) Overrides default org.eclipse.jetty.client.ConnectionPool.preCreateConnections. Optionally pre-create up to `connectionCount` connections so they are immediately ready for use.
protected void	proceed()
public boolean	release(Connection the connection to release connection) Implements org.eclipse.jetty.client.ConnectionPool.release. Returns the given connection, previously obtained via `acquire(boolean)`, back to this ConnectionPool.
protected void	released(Connection connection)
public boolean	remove(Connection the connection to remove connection) Implements org.eclipse.jetty.client.ConnectionPool.remove. Removes the given connection from this ConnectionPool.
protected void	removed(Connection connection)
protected void	setInitialMaxMultiplex(int initialMaxMultiplex)
public void	setMaxDuration(long maxDurationInMs)
public void	setMaximizeConnections(boolean whether the number of connections should be maximized maximizeConnections) Sets whether the number of connections should be maximized.
public void	setMaxUsage(int maxUsage)
public boolean	sweep() Implements org.eclipse.jetty.util.thread.Sweeper.Sweepable.sweep.
public String	toString() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString. Returns a string representation of the object.
protected void	tryCreate(boolean a hint to request to create a connection create) Tries to create a new connection.

Field Detail

destination	back to summary
private final HttpDestination destination

initialMaxMultiplex	back to summary
private volatile int initialMaxMultiplex

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.

maxDurationNanos	back to summary
private volatile long maxDurationNanos

maximizeConnections	back to summary
private boolean maximizeConnections

maxUsage	back to summary
private volatile int maxUsage

pending	back to summary
private final AtomicInteger pending

pool	back to summary
private Pool<Connection> pool

poolFactory	back to summary
private final Pool.Factory<Connection> poolFactory

Constructor Detail

AbstractConnectionPool	back to summary
protected AbstractConnectionPool(Destination destination, Pool.Factory<Connection> poolFactory, int initialMaxMultiplex)

Method Detail

accept	back to summary
public boolean accept(Connection connection) Implements org.eclipse.jetty.client.ConnectionPool.accept. Doc from org.eclipse.jetty.client.ConnectionPool.accept. Accepts the given connection to be managed by this ConnectionPool. Parameters connection:Connection the connection to accept Returns:boolean whether the connection has been accepted Annotations @Override

back to summary

public boolean accept(Connection connection)

Implements org.eclipse.jetty.client.ConnectionPool.accept.

Doc from org.eclipse.jetty.client.ConnectionPool.accept.

Accepts the given connection to be managed by this ConnectionPool.

Parameters

connection:Connection: the connection to accept

Returns:boolean

whether the connection has been accepted

Annotations

@Override

acquire back to summary

acquire	back to summary
public Connection acquire(boolean create) Implements org.eclipse.jetty.client.ConnectionPool.acquire. Returns an idle connection, if available; if an idle connection is not available, and the given `create` parameter is `true` or `isMaximizeConnections()` is `true`, then attempts to open a new connection, if possible within the configuration of this connection pool (for example, if it does not exceed the max connection count); otherwise it attempts to open a new connection, if the number of queued requests is greater than the number of pending connections; if no connection is available even after the attempts to open, return `null`. The `create` parameter is just a hint: the connection may be created even if `false`, or may not be created even if `true`. Parameters create:boolean a hint to attempt to open a new connection if no idle connections are available Returns:Connection an idle connection or `null` if no idle connections are available Annotations @Override See Also `tryCreate(boolean)`

public Connection acquire(boolean create)

Implements org.eclipse.jetty.client.ConnectionPool.acquire.

Returns an idle connection, if available; if an idle connection is not available, and the given create parameter is true or isMaximizeConnections() is true, then attempts to open a new connection, if possible within the configuration of this connection pool (for example, if it does not exceed the max connection count); otherwise it attempts to open a new connection, if the number of queued requests is greater than the number of pending connections; if no connection is available even after the attempts to open, return null.

The create parameter is just a hint: the connection may be created even if false, or may not be created even if true.

Parameters

create:boolean: a hint to attempt to open a new connection if no idle connections are available

Returns:Connection

an idle connection or null if no idle connections are available

Annotations

@Override

See Also

tryCreate(boolean)

acquired	back to summary
protected void acquired(Connection connection)

activate	back to summary
protected Connection activate()

close	back to summary
private void close(Pool.Entry<Connection> entry)

deactivate	back to summary
protected boolean deactivate(Connection connection)

doStart	back to summary
protected void doStart() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

protected void doStart() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Starts the managed lifecycle beans in the order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

If there was a problem starting. Will cause a transition to FAILED state

doStop	back to summary
protected void doStop() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Stops the managed lifecycle beans in the reverse order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

If there was a problem stopping. Will cause a transition to FAILED state

dump	back to summary
public void dump(Appendable out, String indent) throws IOException Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Doc from org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped. Parameters out:Appendable The appendable to dump to indent:String The indent to apply after any new lines. Annotations @Override Exceptions IOException: if unable to write to Appendable

dump

back to summary

public void dump(Appendable out, String indent) throws IOException

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump.

Implements org.eclipse.jetty.util.component.Dumpable.dump.

Doc from org.eclipse.jetty.util.component.Dumpable.dump.

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Parameters

out:Appendable: The appendable to dump to
indent:String: The indent to apply after any new lines.

Annotations

@Override

Exceptions

IOException:: if unable to write to Appendable

getActiveConnectionCount	back to summary
public int getActiveConnectionCount() Annotations @ManagedAttribute:The number of active connections readonly:true

getActiveConnections	back to summary
pack-priv Collection<Connection> getActiveConnections()

getConnectionCount	back to summary
public int getConnectionCount() Annotations @ManagedAttribute:The number of connections readonly:true

getIdleConnectionCount	back to summary
public int getIdleConnectionCount() Annotations @ManagedAttribute:The number of idle connections readonly:true

getIdleConnections	back to summary
pack-priv Collection<Connection> getIdleConnections()

getInitialMaxMultiplex	back to summary
protected int getInitialMaxMultiplex()

getMaxConnectionCount	back to summary
public int getMaxConnectionCount() Annotations @ManagedAttribute:The max number of connections readonly:true

getMaxDuration back to summary

getMaxDuration	back to summary
public long getMaxDuration() Returns the max usage duration in milliseconds of a pooled connection. Values `0` and negative mean that there is no limit. This property only guarantees that a connection cannot be acquired after the configured duration elapses, so that is only enforced when `acquire(boolean)` is called. If a pool stays completely idle for a duration longer than the value returned by this method, the max duration will not be enforced. It's up to the idle timeout mechanism (see `HttpClient#getIdleTimeout()`) to handle closing idle connections. Returns:long the max usage duration, in milliseconds, of a pooled connection Annotations @ManagedAttribute:The maximum duration in milliseconds a connection can be used for before it gets closed

public long getMaxDuration()

Returns the max usage duration in milliseconds of a pooled connection.

Values 0 and negative mean that there is no limit.

This property only guarantees that a connection cannot be acquired after the configured duration elapses, so that is only enforced when acquire(boolean) is called.

If a pool stays completely idle for a duration longer than the value returned by this method, the max duration will not be enforced. It's up to the idle timeout mechanism (see HttpClient#getIdleTimeout()) to handle closing idle connections.

Returns:long

the max usage duration, in milliseconds, of a pooled connection

Annotations

@ManagedAttribute:The maximum duration in milliseconds a connection can be used for before it gets closed

getMaxUsage back to summary

getMaxUsage	back to summary
public int getMaxUsage() Returns the max number of times a pooled connection can be used. Values `0` and negative mean that there is no limit. Returns:int the max number of times a pooled connection can be used Annotations @ManagedAttribute:The maximum amount of times a connection is used before it gets closed

public int getMaxUsage()

Returns the max number of times a pooled connection can be used.

Values 0 and negative mean that there is no limit.

Returns:int

the max number of times a pooled connection can be used

Annotations

@ManagedAttribute:The maximum amount of times a connection is used before it gets closed

getPendingConnectionCount	back to summary
public int getPendingConnectionCount() Annotations @ManagedAttribute:The number of pending connections readonly:true

idle	back to summary
protected boolean idle(Connection connection, boolean close)

isActive	back to summary
public boolean isActive(Connection connection) Implements org.eclipse.jetty.client.ConnectionPool.isActive. Parameters connection:Connection Doc from org.eclipse.jetty.client.ConnectionPool.isActive. the connection to test Returns:boolean Doc from org.eclipse.jetty.client.ConnectionPool.isActive. whether the given connection is currently in use Annotations @Override

isActive

back to summary

public boolean isActive(Connection connection)

Implements org.eclipse.jetty.client.ConnectionPool.isActive.

Parameters

connection:Connection

Doc from org.eclipse.jetty.client.ConnectionPool.isActive.

the connection to test

Returns:boolean

Doc from org.eclipse.jetty.client.ConnectionPool.isActive.

whether the given connection is currently in use

Annotations

@Override

isEmpty	back to summary
public boolean isEmpty() Implements org.eclipse.jetty.client.ConnectionPool.isEmpty. Returns:boolean Doc from org.eclipse.jetty.client.ConnectionPool.isEmpty. whether this ConnectionPool has no open connections Annotations @Override

isEmpty

back to summary

public boolean isEmpty()

Implements org.eclipse.jetty.client.ConnectionPool.isEmpty.

Returns:boolean

Doc from org.eclipse.jetty.client.ConnectionPool.isEmpty.

whether this ConnectionPool has no open connections

Annotations

@Override

isMaximizeConnections	back to summary
public boolean isMaximizeConnections() Annotations @ManagedAttribute:Whether the pool tries to maximize the number of connections used

onCreated	back to summary
protected void onCreated(Connection connection)

preCreateConnections back to summary

preCreateConnections	back to summary
public CompletableFuture<Void> preCreateConnections(int connectionCount) Overrides default org.eclipse.jetty.client.ConnectionPool.preCreateConnections. Doc from org.eclipse.jetty.client.ConnectionPool.preCreateConnections. Optionally pre-create up to `connectionCount` connections so they are immediately ready for use. Parameters connectionCount:int the number of connections to pre-start. Annotations @Override

public CompletableFuture<Void> preCreateConnections(int connectionCount)

Overrides default org.eclipse.jetty.client.ConnectionPool.preCreateConnections.

Doc from org.eclipse.jetty.client.ConnectionPool.preCreateConnections.

Optionally pre-create up to connectionCount connections so they are immediately ready for use.

Parameters

connectionCount:int: the number of connections to pre-start.

Annotations

@Override

proceed	back to summary
protected void proceed()

release back to summary

release	back to summary
public boolean release(Connection connection) Implements org.eclipse.jetty.client.ConnectionPool.release. Doc from org.eclipse.jetty.client.ConnectionPool.release. Returns the given connection, previously obtained via `acquire(boolean)`, back to this ConnectionPool. Parameters connection:Connection the connection to release Returns:boolean true if the connection has been released, false if the connection should be closed Annotations @Override

public boolean release(Connection connection)

Implements org.eclipse.jetty.client.ConnectionPool.release.

Doc from org.eclipse.jetty.client.ConnectionPool.release.

Returns the given connection, previously obtained via acquire(boolean), back to this ConnectionPool.

Parameters

connection:Connection: the connection to release

Returns:boolean

true if the connection has been released, false if the connection should be closed

Annotations

@Override

released	back to summary
protected void released(Connection connection)

remove	back to summary
public boolean remove(Connection connection) Implements org.eclipse.jetty.client.ConnectionPool.remove. Doc from org.eclipse.jetty.client.ConnectionPool.remove. Removes the given connection from this ConnectionPool. Parameters connection:Connection the connection to remove Returns:boolean true if the connection was removed from this ConnectionPool Annotations @Override

remove

back to summary

public boolean remove(Connection connection)

Implements org.eclipse.jetty.client.ConnectionPool.remove.

Doc from org.eclipse.jetty.client.ConnectionPool.remove.

Removes the given connection from this ConnectionPool.

Parameters

connection:Connection: the connection to remove

Returns:boolean

true if the connection was removed from this ConnectionPool

Annotations

@Override

removed	back to summary
protected void removed(Connection connection)

setInitialMaxMultiplex	back to summary
protected void setInitialMaxMultiplex(int initialMaxMultiplex)

setMaxDuration	back to summary
public void setMaxDuration(long maxDurationInMs)

setMaximizeConnections	back to summary
public void setMaximizeConnections(boolean maximizeConnections) Sets whether the number of connections should be maximized. Parameters maximizeConnections:boolean whether the number of connections should be maximized

setMaximizeConnections

back to summary

public void setMaximizeConnections(boolean maximizeConnections)

Sets whether the number of connections should be maximized.

Parameters

maximizeConnections:boolean: whether the number of connections should be maximized

setMaxUsage	back to summary
public void setMaxUsage(int maxUsage)

sweep	back to summary
public boolean sweep() Implements org.eclipse.jetty.util.thread.Sweeper.Sweepable.sweep. Returns:boolean Doc from org.eclipse.jetty.util.thread.Sweeper.Sweepable.sweep. whether this resource should be swept Annotations @Override

sweep

back to summary

public boolean sweep()

Implements org.eclipse.jetty.util.thread.Sweeper.Sweepable.sweep.

Returns:boolean

Doc from org.eclipse.jetty.util.thread.Sweeper.Sweepable.sweep.

whether this resource should be swept

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

tryCreate back to summary

protected void tryCreate(boolean create)

Tries to create a new connection.

Whether a new connection is created is determined by the create parameter and a count of demand and supply, where the demand is derived from the number of queued requests, and the supply is the number of pending connections time the getInitialMaxMultiplex() factor: if the demand is less than the supply, the connection will not be created.

Since the number of queued requests used to derive the demand may be a stale value, it is possible that few more connections than strictly necessary may be created, but enough to satisfy the demand.

Parameters

create:boolean: a hint to request to create a connection

org.eclipse.jetty.client back to summary

private Class AbstractConnectionPool.EntryHolder

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.client.AbstractConnectionPool.EntryHolder

Field Summary

Modifier and Type	Field and Description
private final long	creationNanoTime
private final Pool.Entry<Connection>	entry
private final AtomicInteger	usage

Constructor Summary

Access	Constructor and Description
private	EntryHolder(Pool.Entry<Connection> entry)

Method Summary

Modifier and Type	Method and Description
private boolean	isExpired(long timeoutNanos)
public boolean	isOverUsed(int maxUsage)
private boolean	use(int maxUsage)

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

Field Detail

creationNanoTime	back to summary
private final long creationNanoTime

entry	back to summary
private final Pool.Entry<Connection> entry

usage	back to summary
private final AtomicInteger usage

Constructor Detail

EntryHolder	back to summary
private EntryHolder(Pool.Entry<Connection> entry)

Method Detail

isExpired	back to summary
private boolean isExpired(long timeoutNanos)

isOverUsed	back to summary
public boolean isOverUsed(int maxUsage)

use	back to summary
private boolean use(int maxUsage)

org.eclipse.jetty.client back to summary

private Class AbstractConnectionPool.FutureConnection

Class Inheritance

extends Promise.Completable<Connection>

java.lang.Object
java.util.concurrent.CompletableFuture
org.eclipse.jetty.util.Promise.Completable
org.eclipse.jetty.client.AbstractConnectionPool.FutureConnection

Field Summary

Modifier and Type	Field and Description
private final Pool.Entry<Connection>	reserved

Constructor Summary

Access	Constructor and Description
public	FutureConnection(Pool.Entry<Connection> reserved)

Method Summary

Modifier and Type	Method and Description
public void	failed(Throwable the reason for the operation failure x) Overrides org.eclipse.jetty.util.Promise.Completable.failed. Overrides default org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails.
public void	succeeded(Connection the context connection) Overrides org.eclipse.jetty.util.Promise.Completable.succeeded. Overrides default org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes.