Module org.eclipse.jetty.client

Package org.eclipse.jetty.client

Class AbstractConnectionPool

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.client.AbstractConnectionPool

All Implemented Interfaces:

ConnectionPool, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.thread.Sweeper.Sweepable

Direct Known Subclasses:

DuplexConnectionPool, MultiplexConnectionPool

@ManagedObject
public abstract class AbstractConnectionPool
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements ConnectionPool, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.thread.Sweeper.Sweepable

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.ConnectionPool

ConnectionPool.Factory, ConnectionPool.MaxMultiplexable, ConnectionPool.MaxUsable

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

LEGEND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnectionPool(Destination destination, org.eclipse.jetty.util.Pool.Factory<Connection> poolFactory, int initialMaxMultiplex)

Method Summary

Modifier and Type	Method	Description
boolean	accept(Connection connection)	Accepts the given connection to be managed by this ConnectionPool.
Connection	acquire(boolean create)	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)	Deprecated, for removal: This API element is subject to removal in a future version. Racy API.
protected Connection	activate()
protected boolean	deactivate(Connection connection)
protected void	doStart()
protected void	doStop()
void	dump(Appendable out, String indent)
int	getActiveConnectionCount()
int	getConnectionCount()
int	getIdleConnectionCount()
protected int	getInitialMaxMultiplex()
int	getMaxConnectionCount()
long	getMaxDuration()	Returns the max usage duration in milliseconds of a pooled connection.
int	getMaxUsage()	Returns the max number of times a pooled connection can be used.
int	getPendingConnectionCount()
protected boolean	idle(Connection connection, boolean close)	Deprecated, for removal: This API element is subject to removal in a future version. Racy API.
boolean	isActive(Connection connection)
boolean	isEmpty()
boolean	isMaximizeConnections()
protected void	onCreated(Connection connection)	Callback method invoked when a new Connection has been created.
protected void	onRemoved(Connection connection)	Callback method invoked when a Connection has been removed from this pool.
CompletableFuture<Void>	preCreateConnections(int connectionCount)	Optionally pre-create up to connectionCount connections so they are immediately ready for use.
protected void	proceed()
boolean	release(Connection connection)	Returns the given connection, previously obtained via ConnectionPool.acquire(boolean), back to this ConnectionPool.
protected void	released(Connection connection)	Deprecated, for removal: This API element is subject to removal in a future version. Racy API.
boolean	remove(Connection connection)	Removes the given connection from this ConnectionPool.
protected void	removed(Connection connection)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by onRemoved(Connection)
protected void	setInitialMaxMultiplex(int initialMaxMultiplex)
void	setMaxDuration(long maxDurationInMs)
void	setMaximizeConnections(boolean maximizeConnections)	Sets whether the number of connections should be maximized.
void	setMaxUsage(int maxUsage)
boolean	sweep()
String	toString()
protected void	tryCreate(boolean create)	Tries to create a new connection.

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Constructor Details

AbstractConnectionPool

protected AbstractConnectionPool(Destination destination,
 org.eclipse.jetty.util.Pool.Factory<Connection> poolFactory,
 int initialMaxMultiplex)

Method Details

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

preCreateConnections

public CompletableFuture<Void> preCreateConnections(int connectionCount)

Description copied from interface: ConnectionPool

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

Specified by:

preCreateConnections in interface ConnectionPool

Parameters:

connectionCount - the number of connections to pre-start.

getMaxDuration

@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:

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

setMaxDuration

public void setMaxDuration(long maxDurationInMs)

getInitialMaxMultiplex

protected int getInitialMaxMultiplex()

setInitialMaxMultiplex

protected void setInitialMaxMultiplex(int initialMaxMultiplex)

getMaxUsage

@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:

the max number of times a pooled connection can be used

setMaxUsage

public void setMaxUsage(int maxUsage)

getActiveConnectionCount

@ManagedAttribute(value="The number of active connections",
                  readonly=true)
public int getActiveConnectionCount()

getIdleConnectionCount

@ManagedAttribute(value="The number of idle connections",
                  readonly=true)
public int getIdleConnectionCount()

getMaxConnectionCount

@ManagedAttribute(value="The max number of connections",
                  readonly=true)
public int getMaxConnectionCount()

getConnectionCount

@ManagedAttribute(value="The number of connections",
                  readonly=true)
public int getConnectionCount()

getPendingConnectionCount

@ManagedAttribute(value="The number of pending connections",
                  readonly=true)
public int getPendingConnectionCount()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConnectionPool

Returns:

whether this ConnectionPool has no open connections

isMaximizeConnections

@ManagedAttribute("Whether the pool tries to maximize the number of connections used")
public boolean isMaximizeConnections()

setMaximizeConnections

public void setMaximizeConnections(boolean maximizeConnections)

Sets whether the number of connections should be maximized.

Parameters:

maximizeConnections - whether the number of connections should be maximized

acquire

public Connection acquire(boolean create)

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.

Specified by:

acquire in interface ConnectionPool

Parameters:

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

Returns:

an idle connection or null if no idle connections are available

See Also:

• tryCreate(boolean)

tryCreate

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 - a hint to request to create a connection

accept

public boolean accept(Connection connection)

Description copied from interface: ConnectionPool

Accepts the given connection to be managed by this ConnectionPool.

Specified by:

accept in interface ConnectionPool

Parameters:

connection - the connection to accept

Returns:

whether the connection has been accepted

proceed

protected void proceed()

activate

protected Connection activate()

isActive

public boolean isActive(Connection connection)

Specified by:

isActive in interface ConnectionPool

Parameters:

connection - the connection to test

Returns:

whether the given connection is currently in use

release

public boolean release(Connection connection)

Description copied from interface: ConnectionPool

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

Specified by:

release in interface ConnectionPool

Parameters:

connection - the connection to release

Returns:

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

deactivate

protected boolean deactivate(Connection connection)

remove

public boolean remove(Connection connection)

Description copied from interface: ConnectionPool

Removes the given connection from this ConnectionPool.

Specified by:

remove in interface ConnectionPool

Parameters:

connection - the connection to remove

Returns:

true if the connection was removed from this ConnectionPool

onCreated

protected void onCreated(Connection connection)

Callback method invoked when a new Connection has been created.

Parameters:

connection - the Connection that has been created

See Also:

• onRemoved(Connection)

idle

@Deprecated(since="12.0.8",
            forRemoval=true)
protected boolean idle(Connection connection,
 boolean close)

Deprecated, for removal: This API element is subject to removal in a future version.

Racy API. Do not use. There is no replacement.

Parameters:

connection - the Connection that become idle

close - whether this pool is closing

Returns:

true to indicate that the connection is idle, false otherwise

acquired

@Deprecated(since="12.0.8",
            forRemoval=true)
protected void acquired(Connection connection)

Deprecated, for removal: This API element is subject to removal in a future version.

Racy API. Do not use. There is no replacement.

Parameters:

connection - the Connection that was acquired

released

@Deprecated(since="12.0.8",
            forRemoval=true)
protected void released(Connection connection)

Deprecated, for removal: This API element is subject to removal in a future version.

Racy API. Do not use. There is no replacement.

Parameters:

connection - the Connection that was released

removed

@Deprecated(since="12.0.8",
            forRemoval=true)
protected void removed(Connection connection)

Deprecated, for removal: This API element is subject to removal in a future version.

replaced by onRemoved(Connection)

Parameters:

connection - the Connection that was removed

onRemoved

protected void onRemoved(Connection connection)

Callback method invoked when a Connection has been removed from this pool.

Parameters:

connection - the Connection that was removed

See Also:

• onCreated(Connection)

dump

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

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException

sweep

public boolean sweep()

Specified by:

sweep in interface org.eclipse.jetty.util.thread.Sweeper.Sweepable

toString

public String toString()

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle