Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ThreadSafeClientConnManager

extends Object
implements ClientConnectionManager
java.lang.Object
   ↳ org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager

Class Overview

Manages a pool of client connections .

This class is derived from MultiThreadedHttpConnectionManager in HttpClient 3. See there for original authors.

Summary

Fields
protected ClientConnectionOperator connOperator The operator for opening and updating connections.
protected final AbstractConnPool connectionPool The pool of connections being managed.
protected SchemeRegistry schemeRegistry The schemes supported by this connection manager.
Public Constructors
ThreadSafeClientConnManager ( HttpParams params, SchemeRegistry schreg)
Creates a new thread safe connection manager.
Public Methods
void closeExpiredConnections ()
Closes all expired connections in the pool.
void closeIdleConnections (long idleTimeout, TimeUnit tunit)
Closes idle connections in the pool.
int getConnectionsInPool ( HttpRoute route)
Gets the total number of pooled connections for the given route.
int getConnectionsInPool ()
Gets the total number of pooled connections.
SchemeRegistry getSchemeRegistry ()
Obtains the scheme registry used by this manager.
void releaseConnection ( ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
Releases a connection for use by others.
ClientConnectionRequest requestConnection ( HttpRoute route, Object state)
Returns a new ClientConnectionRequest , from which a ManagedClientConnection can be obtained or the request can be aborted.
void shutdown ()
Shuts down this connection manager and releases allocated resources.
Protected Methods
ClientConnectionOperator createConnectionOperator ( SchemeRegistry schreg)
Hook for creating the connection operator.
AbstractConnPool createConnectionPool ( HttpParams params)
Hook for creating the connection pool.
void finalize ()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.conn.ClientConnectionManager

Fields

protected ClientConnectionOperator connOperator

Added in API level 1

The operator for opening and updating connections.

protected final AbstractConnPool connectionPool

Added in API level 1

The pool of connections being managed.

protected SchemeRegistry schemeRegistry

Added in API level 1

The schemes supported by this connection manager.

Public Constructors

public ThreadSafeClientConnManager ( HttpParams params, SchemeRegistry schreg)

Added in API level 1

Creates a new thread safe connection manager.

Parameters
params the parameters for this manager
schreg the scheme registry

Public Methods

public void closeExpiredConnections ()

Added in 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 void closeIdleConnections (long idleTimeout, TimeUnit tunit)

Added in 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
idleTimeout the idle time of connections to be closed
tunit the unit for the idletime

public int getConnectionsInPool ( HttpRoute route)

Added in API level 1

Gets the total number of pooled connections for the given route. This is the total number of connections that have been created and are still in use by this connection manager for the route. This value will not exceed the maximum number of connections per host.

Parameters
route the route in question
Returns
  • the total number of pooled connections for that route

public int getConnectionsInPool ()

Added in API level 1

Gets the total number of pooled connections. This is the total number of connections that have been created and are still in use by this connection manager. This value will not exceed the maximum number of connections in total.

Returns
  • the total number of pooled connections

public SchemeRegistry getSchemeRegistry ()

Added in API level 1

Obtains the scheme registry used by this manager.

Returns
  • the scheme registry, never null

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

Added in 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

public ClientConnectionRequest requestConnection ( HttpRoute route, Object state)

Added in API level 1

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

public void shutdown ()

Added in API level 1

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

Protected Methods

protected ClientConnectionOperator createConnectionOperator ( SchemeRegistry schreg)

Added in API level 1

Hook for creating the connection operator. It is called by the constructor. Derived classes can override this method to change the instantiation of the operator. The default implementation here instantiates DefaultClientConnectionOperator .

Parameters
schreg the scheme registry to use, or null
Returns
  • the connection operator to use

protected AbstractConnPool createConnectionPool ( HttpParams params)

Added in API level 1

Hook for creating the connection pool.

Returns
  • the connection pool to use

protected void finalize ()

Added in API level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable ), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.