org.apache.hc.client5.http.impl.nio

类 PoolingAsyncClientConnectionManager

java.lang.Object

org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager

所有已实现的接口:

Closeable, AutoCloseable, AsyncClientConnectionManager, ModalCloseable, ConnPoolControl<HttpRoute>, ConnPoolStats<HttpRoute>

@Contract(threading=SAFE_CONDITIONAL)
public class PoolingAsyncClientConnectionManager
extends Object
implements AsyncClientConnectionManager, ConnPoolControl<HttpRoute>

PoolingAsyncClientConnectionManager maintains a pool of non-blocking HttpConnections and is able to service connection requests from multiple execution threads. Connections are pooled on a per route basis. A request for a route which already the manager has persistent connections for available in the pool will be services by leasing a connection from the pool rather than creating a new connection.

PoolingAsyncClientConnectionManager maintains a maximum limit of connection on a per route basis and in total. Connection limits can be adjusted using ConnPoolControl methods.

Total time to live (TTL) set at construction time defines maximum life span of persistent connections regardless of their expiration setting. No persistent connection will be re-used past its TTL value.

从以下版本开始:

5.0

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_MAX_CONNECTIONS_PER_ROUTE
static int	DEFAULT_MAX_TOTAL_CONNECTIONS

构造器概要

构造器

限定符	构造器和说明
	PoolingAsyncClientConnectionManager()
protected	PoolingAsyncClientConnectionManager(AsyncClientConnectionOperator connectionOperator, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive)
	PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup)
	PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive)
	PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive, SchemePortResolver schemePortResolver, DnsResolver dnsResolver)
	PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup, PoolConcurrencyPolicy poolConcurrencyPolicy, TimeValue timeToLive)
protected	PoolingAsyncClientConnectionManager(ManagedConnPool<HttpRoute,ManagedAsyncClientConnection> pool, AsyncClientConnectionOperator connectionOperator)

方法概要

限定符和类型	方法和说明
void	close()
void	close(CloseMode closeMode) Closes this process or endpoint and releases any system resources associated with it.
void	closeExpired()
void	closeIdle(TimeValue idletime)
Future<AsyncConnectionEndpoint>	connect(AsyncConnectionEndpoint endpoint, ConnectionInitiator connectionInitiator, Timeout timeout, Object attachment, HttpContext context, FutureCallback<AsyncConnectionEndpoint> callback) Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).
int	getDefaultMaxPerRoute()
int	getMaxPerRoute(HttpRoute route)
int	getMaxTotal()
Set<HttpRoute>	getRoutes()
PoolStats	getStats(HttpRoute route)
PoolStats	getTotalStats()
TimeValue	getValidateAfterInactivity() 已过时。 Use custom setConnectionConfigResolver(Resolver)
Future<AsyncConnectionEndpoint>	lease(String id, HttpRoute route, Object state, Timeout requestTimeout, FutureCallback<AsyncConnectionEndpoint> callback) Returns a Future object which can be used to obtain an AsyncConnectionEndpoint or to cancel the request by calling Future.cancel(boolean).
void	release(AsyncConnectionEndpoint endpoint, Object state, TimeValue keepAlive) Releases the endpoint back to the manager making it potentially re-usable by other consumers.
void	setConnectionConfigResolver(Resolver<HttpRoute,ConnectionConfig> connectionConfigResolver) Sets Resolver of ConnectionConfig on a per route basis.
void	setDefaultConnectionConfig(ConnectionConfig config) Sets the same ConnectionConfig for all routes
void	setDefaultMaxPerRoute(int max)
void	setDefaultTlsConfig(TlsConfig config) Sets the same ConnectionConfig for all hosts
void	setMaxPerRoute(HttpRoute route, int max)
void	setMaxTotal(int max)
void	setTlsConfigResolver(Resolver<HttpHost,TlsConfig> tlsConfigResolver) Sets Resolver of TlsConfig on a per host basis.
void	setValidateAfterInactivity(TimeValue validateAfterInactivity) 已过时。 Use setConnectionConfigResolver(Resolver).
void	upgrade(AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context) Upgrades transport security of the given endpoint by using the TLS security protocol.
void	upgrade(AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context, FutureCallback<AsyncConnectionEndpoint> callback) Upgrades transport security of the given endpoint by using the TLS security protocol.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_MAX_TOTAL_CONNECTIONS

public static final int DEFAULT_MAX_TOTAL_CONNECTIONS

另请参阅:

常量字段值

DEFAULT_MAX_CONNECTIONS_PER_ROUTE

public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE

另请参阅:

常量字段值

构造器详细资料

PoolingAsyncClientConnectionManager

public PoolingAsyncClientConnectionManager()

PoolingAsyncClientConnectionManager

public PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup)

PoolingAsyncClientConnectionManager

public PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup,
                                           PoolConcurrencyPolicy poolConcurrencyPolicy,
                                           TimeValue timeToLive)

PoolingAsyncClientConnectionManager

public PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup,
                                           PoolConcurrencyPolicy poolConcurrencyPolicy,
                                           PoolReusePolicy poolReusePolicy,
                                           TimeValue timeToLive)

PoolingAsyncClientConnectionManager

public PoolingAsyncClientConnectionManager(Lookup<TlsStrategy> tlsStrategyLookup,
                                           PoolConcurrencyPolicy poolConcurrencyPolicy,
                                           PoolReusePolicy poolReusePolicy,
                                           TimeValue timeToLive,
                                           SchemePortResolver schemePortResolver,
                                           DnsResolver dnsResolver)

PoolingAsyncClientConnectionManager

@Internal
protected PoolingAsyncClientConnectionManager(AsyncClientConnectionOperator connectionOperator,
                                                        PoolConcurrencyPolicy poolConcurrencyPolicy,
                                                        PoolReusePolicy poolReusePolicy,
                                                        TimeValue timeToLive)

PoolingAsyncClientConnectionManager

@Internal
protected PoolingAsyncClientConnectionManager(ManagedConnPool<HttpRoute,ManagedAsyncClientConnection> pool,
                                                        AsyncClientConnectionOperator connectionOperator)

方法详细资料

close

public void close()

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

close

public void close(CloseMode closeMode)

从接口复制的说明: ModalCloseable

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.

指定者:

close 在接口中 ModalCloseable

参数:

closeMode - How to close the receiver.

lease

public Future<AsyncConnectionEndpoint> lease(String id,
                                             HttpRoute route,
                                             Object state,
                                             Timeout requestTimeout,
                                             FutureCallback<AsyncConnectionEndpoint> callback)

从接口复制的说明: AsyncClientConnectionManager

Returns a Future object which can be used to obtain an AsyncConnectionEndpoint or to cancel the request by calling Future.cancel(boolean).

Please note that newly allocated endpoints can be leased disconnected. The consumer of the endpoint is responsible for fully establishing the route to the endpoint target by calling AsyncClientConnectionManager.connect(AsyncConnectionEndpoint, ConnectionInitiator, Timeout, Object, HttpContext, FutureCallback) in order to connect directly to the target or to the first proxy hop, and optionally calling AsyncClientConnectionManager.upgrade(AsyncConnectionEndpoint, Object, HttpContext) method to upgrade the underlying transport to Transport Layer Security after having executed a CONNECT method to all intermediate proxy hops.

指定者:

lease 在接口中 AsyncClientConnectionManager

参数:

id - unique operation ID or null.

route - HTTP route of the requested connection.

state - expected state of the connection or null if the connection is not expected to carry any state.

requestTimeout - lease request timeout.

callback - result callback.

release

public void release(AsyncConnectionEndpoint endpoint,
                    Object state,
                    TimeValue keepAlive)

从接口复制的说明: AsyncClientConnectionManager

Releases the endpoint back to the manager making it potentially re-usable by other consumers. Optionally, the maximum period of how long the manager should keep the connection alive can be defined using validDuration and timeUnit parameters.

指定者:

release 在接口中 AsyncClientConnectionManager

参数:

endpoint - the managed endpoint.

state - the new connection state of null if state-less.

keepAlive - the duration of time this connection is valid for reuse.

connect

public Future<AsyncConnectionEndpoint> connect(AsyncConnectionEndpoint endpoint,
                                               ConnectionInitiator connectionInitiator,
                                               Timeout timeout,
                                               Object attachment,
                                               HttpContext context,
                                               FutureCallback<AsyncConnectionEndpoint> callback)

从接口复制的说明: AsyncClientConnectionManager

Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).

指定者:

connect 在接口中 AsyncClientConnectionManager

参数:

endpoint - the managed endpoint.

timeout - connect timeout.

attachment - connect request attachment.

context - the actual HTTP context.

callback - result callback.

upgrade

public void upgrade(AsyncConnectionEndpoint endpoint,
                    Object attachment,
                    HttpContext context,
                    FutureCallback<AsyncConnectionEndpoint> callback)

从接口复制的说明: AsyncClientConnectionManager

Upgrades transport security of the given endpoint by using the TLS security protocol.

指定者:

upgrade 在接口中 AsyncClientConnectionManager

参数:

endpoint - the managed endpoint.

attachment - the attachment the upgrade attachment object.

context - the actual HTTP context.

callback - result callback.

upgrade

public void upgrade(AsyncConnectionEndpoint endpoint,
                    Object attachment,
                    HttpContext context)

从接口复制的说明: AsyncClientConnectionManager

Upgrades transport security of the given endpoint by using the TLS security protocol.

指定者:

upgrade 在接口中 AsyncClientConnectionManager

参数:

endpoint - the managed endpoint.

attachment - the attachment the upgrade attachment object.

context - the actual HTTP context.

getRoutes

public Set<HttpRoute> getRoutes()

指定者:

getRoutes 在接口中 ConnPoolControl<HttpRoute>

setMaxTotal

public void setMaxTotal(int max)

指定者:

setMaxTotal 在接口中 ConnPoolControl<HttpRoute>

getMaxTotal

public int getMaxTotal()

指定者:

getMaxTotal 在接口中 ConnPoolControl<HttpRoute>

setDefaultMaxPerRoute

public void setDefaultMaxPerRoute(int max)

指定者:

setDefaultMaxPerRoute 在接口中 ConnPoolControl<HttpRoute>

getDefaultMaxPerRoute

public int getDefaultMaxPerRoute()

指定者:

getDefaultMaxPerRoute 在接口中 ConnPoolControl<HttpRoute>

setMaxPerRoute

public void setMaxPerRoute(HttpRoute route,
                           int max)

指定者:

setMaxPerRoute 在接口中 ConnPoolControl<HttpRoute>

getMaxPerRoute

public int getMaxPerRoute(HttpRoute route)

指定者:

getMaxPerRoute 在接口中 ConnPoolControl<HttpRoute>

closeIdle

public void closeIdle(TimeValue idletime)

指定者:

closeIdle 在接口中 ConnPoolControl<HttpRoute>

closeExpired

public void closeExpired()

指定者:

closeExpired 在接口中 ConnPoolControl<HttpRoute>

getTotalStats

public PoolStats getTotalStats()

指定者:

getTotalStats 在接口中 ConnPoolStats<HttpRoute>

getStats

public PoolStats getStats(HttpRoute route)

指定者:

getStats 在接口中 ConnPoolStats<HttpRoute>

setDefaultConnectionConfig

public void setDefaultConnectionConfig(ConnectionConfig config)

Sets the same ConnectionConfig for all routes

从以下版本开始:

5.2

setConnectionConfigResolver

public void setConnectionConfigResolver(Resolver<HttpRoute,ConnectionConfig> connectionConfigResolver)

Sets Resolver of ConnectionConfig on a per route basis.

从以下版本开始:

5.2

setDefaultTlsConfig

public void setDefaultTlsConfig(TlsConfig config)

Sets the same ConnectionConfig for all hosts

从以下版本开始:

5.2

setTlsConfigResolver

public void setTlsConfigResolver(Resolver<HttpHost,TlsConfig> tlsConfigResolver)

Sets Resolver of TlsConfig on a per host basis.

从以下版本开始:

5.2

getValidateAfterInactivity

@Deprecated
public TimeValue getValidateAfterInactivity()

已过时。 Use custom setConnectionConfigResolver(Resolver)

setValidateAfterInactivity

@Deprecated
public void setValidateAfterInactivity(TimeValue validateAfterInactivity)

已过时。 Use setConnectionConfigResolver(Resolver).

Defines period of inactivity after which persistent connections must be re-validated prior to being lease(String, HttpRoute, Object, Timeout, FutureCallback) leased} to the consumer. Negative values passed to this method disable connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool.