FileDocCategorySizeDatePackage
ClientConnectionManager.javaAPI DocAndroid 1.5 API4572Wed May 06 22:41:10 BST 2009org.apache.http.conn

ClientConnectionManager

public interface ClientConnectionManager
Management interface for {@link ManagedClientConnection client connections}.
author
Michael Becke
author
Mike Bowler
author
Oleg Kalnichevski
author
Roland Weber
version
$Revision: 671717 $
since
4.0

Fields Summary
Constructors Summary
Methods Summary
public voidcloseExpiredConnections()
Closes all expired connections in the pool. Open connections in the pool that have not been used for the timespan defined when the connection was released will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision.

public voidcloseIdleConnections(long idletime, java.util.concurrent.TimeUnit tunit)
Closes idle connections in the pool. Open connections in the pool that have not been used for the timespan given by the argument will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision All expired connections will also be closed.

param
idletime the idle time of connections to be closed
param
tunit the unit for the idletime
see
#closeExpiredConnections()

public org.apache.http.conn.scheme.SchemeRegistrygetSchemeRegistry()
Obtains the scheme registry used by this manager.

return
the scheme registry, never null

public voidreleaseConnection(org.apache.http.conn.ManagedClientConnection conn, long validDuration, java.util.concurrent.TimeUnit timeUnit)
Releases a connection for use by others. You may optionally specify how long the connection is valid to be reused. Values <= 0 are considered to be valid forever. If the connection is not marked as reusable, the connection will not be reused regardless of the valid duration. If the connection has been released before, the call will be ignored.

param
conn the connection to release
param
validDuration the duration of time this connection is valid for reuse
param
timeUnit the unit of time validDuration is measured in
see
#closeExpiredConnections()

public org.apache.http.conn.ClientConnectionRequestrequestConnection(org.apache.http.conn.routing.HttpRoute route, java.lang.Object state)
Returns a new {@link ClientConnectionRequest}, from which a {@link ManagedClientConnection} can be obtained or the request can be aborted.

public voidshutdown()
Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.