Module org.eclipse.jetty.client

Package org.eclipse.jetty.client

Interface ConnectionPool

All Known Implementing Classes:

AbstractConnectionPool, DuplexConnectionPool, MultiplexConnectionPool, RandomConnectionPool, RoundRobinConnectionPool, ValidatingConnectionPool

public interface ConnectionPool

Client-side connection pool abstraction.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConnectionPool.Factory	Factory for ConnectionPool instances.
static interface	ConnectionPool.MaxMultiplexable	Marks a connection as supporting multiplexed requests.
static interface	ConnectionPool.MaxUsable	Marks a connection as being usable for a maximum number of requests.

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, then schedules the opening of a new connection, if possible within the configuration of this connection pool (for example, if it does not exceed the max connection count); otherwise returns null.
boolean	isActive(Connection connection)
boolean	isEmpty()
default CompletableFuture<Void>	preCreateConnections(int connectionCount)	Optionally pre-create up to connectionCount connections so they are immediately ready for use.
boolean	release(Connection connection)	Returns the given connection, previously obtained via acquire(boolean), back to this ConnectionPool.
boolean	remove(Connection connection)	Removes the given connection from this ConnectionPool.

Method Details

preCreateConnections

default CompletableFuture<Void> preCreateConnections(int connectionCount)

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

Parameters:

connectionCount - the number of connections to pre-start.

isActive

boolean isActive(Connection connection)

Parameters:

connection - the connection to test

Returns:

whether the given connection is currently in use

isEmpty

boolean isEmpty()

Returns:

whether this ConnectionPool has no open connections

acquire

Connection acquire(boolean create)

Returns an idle connection, if available; if an idle connection is not available, and the given create parameter is true, then schedules the opening of a new connection, if possible within the configuration of this connection pool (for example, if it does not exceed the max connection count); otherwise returns null.

Parameters:

create - whether to schedule the opening of a connection if no idle connections are available

Returns:

an idle connection or null if no idle connections are available

accept

boolean accept(Connection connection)

Accepts the given connection to be managed by this ConnectionPool.

Parameters:

connection - the connection to accept

Returns:

whether the connection has been accepted

release

boolean release(Connection connection)

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

Parameters:

connection - the connection to release

Returns:

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

remove

boolean remove(Connection connection)

Removes the given connection from this ConnectionPool.

Parameters:

connection - the connection to remove

Returns:

true if the connection was removed from this ConnectionPool