org.apache.http.conn: public interface: ClientConnectionManager

org.apache.http.conn
public interface: ClientConnectionManager [javadoc | source]

All Known Implementing Classes:
ThreadSafeClientConnManager, SingleClientConnManager

Management interface for client connections . The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, manage persistent connections and synchronize access to persistent connections making sure that only one thread of execution can have access to a connection at a time.

Implementations of this interface must be thread-safe. Access to shared data must be synchronized as methods of this interface may be executed from multiple threads.

since: 4.0 -

Method from org.apache.http.conn.ClientConnectionManager Summary:
closeExpiredConnections, closeIdleConnections, getSchemeRegistry, releaseConnection, requestConnection, shutdown

Method from org.apache.http.conn.ClientConnectionManager Detail:
public void closeExpiredConnections() 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 void closeIdleConnections(long idletime, 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.
public SchemeRegistry getSchemeRegistry() Obtains the scheme registry used by this manager.
public void releaseConnection(ManagedClientConnection conn, long validDuration, 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.
public ClientConnectionRequest requestConnection(HttpRoute route, Object state) Returns a new ClientConnectionRequest , from which a ManagedClientConnection can be obtained or the request can be aborted.
public void shutdown() Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.