Summary: Methods | [Expand All]
Since: API Level 1
public interface

ClientConnectionManager

org.apache.http.conn.ClientConnectionManager
Known Indirect Subclasses

Class Overview

Management interface for client connections.

Summary

Public Methods
abstract void closeExpiredConnections()
Closes all expired connections in the pool.
abstract void closeIdleConnections(long idletime, TimeUnit tunit)
Closes idle connections in the pool.
abstract SchemeRegistry getSchemeRegistry()
Obtains the scheme registry used by this manager.
abstract void releaseConnection(ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
Releases a connection for use by others.
abstract ClientConnectionRequest requestConnection(HttpRoute route, Object state)
Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.
abstract void shutdown()
Shuts down this connection manager and releases allocated resources.

Public Methods

public abstract void closeExpiredConnections ()

Since: API Level 1

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 abstract void closeIdleConnections (long idletime, TimeUnit tunit)

Since: API Level 1

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.

Parameters
idletime the idle time of connections to be closed
tunit the unit for the idletime
See Also

public abstract SchemeRegistry getSchemeRegistry ()

Since: API Level 1

Obtains the scheme registry used by this manager.

Returns
  • the scheme registry, never null

public abstract void releaseConnection (ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)

Since: API Level 1

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.

Parameters
conn the connection to release
validDuration the duration of time this connection is valid for reuse
timeUnit the unit of time validDuration is measured in
See Also

public abstract ClientConnectionRequest requestConnection (HttpRoute route, Object state)

Since: API Level 1

Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.

public abstract void shutdown ()

Since: API Level 1

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