Android - An Open Handset Alliance Project

org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager

Android - An Open Handset Alliance Project

Documentation

Roadmap

Goodies

org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager

Summary

Details

Summary

Details

Fields

Public Constructors

Public Methods

Protected Methods

Fields

Public Constructors

Public Methods

Protected Methods

Fields

Public Constructors

Public Methods

Protected Methods

Fields

Public Constructors

Public Methods

Protected Methods

protected ClientConnectionOperator connOperator

protected final AbstractConnPool connectionPool

protected SchemeRegistry schemeRegistry

public ThreadSafeClientConnManager(HttpParams params, SchemeRegistry schreg)

Parameters

public void closeExpiredConnections()

public void closeIdleConnections(long idleTimeout, TimeUnit tunit)

public int getConnectionsInPool()

Returns

public int getConnectionsInPool(HttpRoute route)

Parameters

Returns

public SchemeRegistry getSchemeRegistry()

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

public ClientConnectionRequest requestConnection(HttpRoute route, Object state)

public void shutdown()

protected ClientConnectionOperator createConnectionOperator(SchemeRegistry schreg)

Parameters

Returns

protected AbstractConnPool createConnectionPool(HttpParams params)

Returns

protected void finalize()

Throws

protected ClientConnectionOperator connOperator

protected final AbstractConnPool connectionPool

protected SchemeRegistry schemeRegistry

public ThreadSafeClientConnManager(HttpParams params, SchemeRegistry schreg)

Parameters

public void closeExpiredConnections()

public void closeIdleConnections(long idleTimeout, TimeUnit tunit)

public int getConnectionsInPool()

Returns

public int getConnectionsInPool(HttpRoute route)

Parameters

Returns

public SchemeRegistry getSchemeRegistry()

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

public ClientConnectionRequest requestConnection(HttpRoute route, Object state)

public void shutdown()

protected ClientConnectionOperator createConnectionOperator(SchemeRegistry schreg)

Parameters

Returns

protected AbstractConnPool createConnectionPool(HttpParams params)

Returns

protected void finalize()

Throws

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.conn.ClientConnectionManager

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.conn.ClientConnectionManager

org.apache.http.impl.conn.tsccm
public class

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

Manages a pool of client connections.

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

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.

						ThreadSafeClientConnManager(HttpParams params, SchemeRegistry schreg)
						Creates a new thread safe connection manager.

					void	closeExpiredConnections()
						Closes all expired connections in the pool.
					void	closeIdleConnections(long idleTimeout, TimeUnit tunit)
						Closes idle connections in the pool.
					int	getConnectionsInPool()
						Gets the total number of pooled connections.
					int	getConnectionsInPool(HttpRoute route)
						Gets the total number of pooled connections for the given route.
					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.

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

	Object	clone()
		Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class<? extends Object>	getClass()
		Returns the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Returns an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Returns a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

closeExpiredConnections, closeIdleConnections, getSchemeRegistry, releaseConnection, requestConnection, shutdown

The operator for opening and updating connections.

The pool of connections being managed.

The schemes supported by this connection manager.

Creates a new thread safe connection manager.

params	the parameters for this manager
schreg	the scheme registry, or `null` for the default registry

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.

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.

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.

the total number of pooled connections

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.

route	the route in question

the total number of pooled connections for that route

Obtains the scheme registry used by this manager.

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.

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

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

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.

schreg	the scheme registry to use, or `null`

the connection operator to use

Hook for creating the connection pool.

the connection pool to use

Called by the virtual machine when there are no longer any (non-weak) references to the receiver. Subclasses can use this facility to guarantee that any associated resources are cleaned up before the receiver is garbage collected. Uncaught exceptions which are thrown during the running of the method cause it to terminate immediately, but are otherwise ignored.

Note: The virtual machine assumes that the implementation in class Object is empty.

Throwable

ClientConnectionOperator

createConnectionOperator(SchemeRegistry schreg)

Hook for creating the connection operator.

AbstractConnPool

createConnectionPool(HttpParams params)

Hook for creating the connection pool.

finalize()

Called by the virtual machine when there are no longer any (non-weak) references to the receiver.


e.g. "intent" or "activity"