org.apache.http.impl.conn.tsccm.AbstractConnPool

Documentation

Roadmap

Goodies

org.apache.http.impl.conn.tsccm.AbstractConnPool

Summary

Details

Summary

Details

Fields

Protected Constructors

Public Methods

Protected Methods

Fields

Protected Constructors

Public Methods

Protected Methods

Fields

Protected Constructors

Public Methods

Protected Methods

Fields

Protected Constructors

Public Methods

Protected Methods

protected IdleConnectionHandler idleConnHandler

protected boolean isShutDown

protected Set<BasicPoolEntryRef> issuedConnections

protected int numConnections

protected final Lock poolLock

protected ReferenceQueue<Object> refQueue

protected AbstractConnPool()

public void closeExpiredConnections()

public void closeIdleConnections(long idletime, TimeUnit tunit)

Parameters

public abstract void deleteClosedConnections()

public void enableConnectionGC()

Throws

public abstract void freeEntry(BasicPoolEntry entry, boolean reusable, long validDuration, TimeUnit timeUnit)

Parameters

public final BasicPoolEntry getEntry(HttpRoute route, Object state, long timeout, TimeUnit tunit)

Parameters

Returns

Throws

public void handleReference(Reference ref)

public abstract PoolEntryRequest requestPoolEntry(HttpRoute route, Object state)

public void shutdown()

protected void closeConnection(OperatedClientConnection conn)

Parameters

protected abstract void handleLostEntry(HttpRoute route)

Parameters

protected IdleConnectionHandler idleConnHandler

protected boolean isShutDown

protected Set<BasicPoolEntryRef> issuedConnections

protected int numConnections

protected final Lock poolLock

protected ReferenceQueue<Object> refQueue

protected AbstractConnPool()

public void closeExpiredConnections()

public void closeIdleConnections(long idletime, TimeUnit tunit)

Parameters

public abstract void deleteClosedConnections()

public void enableConnectionGC()

Throws

public abstract void freeEntry(BasicPoolEntry entry, boolean reusable, long validDuration, TimeUnit timeUnit)

Parameters

public final BasicPoolEntry getEntry(HttpRoute route, Object state, long timeout, TimeUnit tunit)

Parameters

Returns

Throws

public void handleReference(Reference ref)

public abstract PoolEntryRequest requestPoolEntry(HttpRoute route, Object state)

public void shutdown()

protected void closeConnection(OperatedClientConnection conn)

Parameters

protected abstract void handleLostEntry(HttpRoute route)

Parameters

Known Direct Subclasses

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.impl.conn.tsccm.RefQueueHandler

Known Direct Subclasses

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.impl.conn.tsccm.RefQueueHandler

Android

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

java.lang.Object
	org.apache.http.impl.conn.tsccm.AbstractConnPool	RefQueueHandler

An abstract connection pool. It is used by the ThreadSafeClientConnManager. The abstract pool includes a poolLock, which is used to synchronize access to the internal pool datastructures. Don't use synchronized for that purpose!

ConnPoolByRoute

protected		IdleConnectionHandler	idleConnHandler	The handler for idle connections.
protected		boolean	isShutDown	Indicates whether this pool is shut down.
protected		Set<BasicPoolEntryRef>	issuedConnections	References to issued connections.
protected		int	numConnections	The current total number of connections.
protected	final	Lock	poolLock	The global lock for this pool.
protected		ReferenceQueue<Object>	refQueue	A reference queue to track loss of pool entries to GC.

						AbstractConnPool()
						Creates a new connection pool.

		void	closeExpiredConnections()
		void	closeIdleConnections(long idletime, TimeUnit tunit)
			Closes idle connections.
abstract		void	deleteClosedConnections()
			Deletes all entries for closed connections.
		void	enableConnectionGC()
			Enables connection garbage collection (GC).
abstract		void	freeEntry(BasicPoolEntry entry, boolean reusable, long validDuration, TimeUnit timeUnit)
			Returns an entry into the pool.
	final	BasicPoolEntry	getEntry(HttpRoute route, Object state, long timeout, TimeUnit tunit)
			Obtains a pool entry with a connection within the given timeout.
		void	handleReference(Reference ref)
abstract		PoolEntryRequest	requestPoolEntry(HttpRoute route, Object state)
			Returns a new PoolEntryRequest, from which a BasicPoolEntry can be obtained, or the request can be aborted.
		void	shutdown()
			Shuts down this pool and all associated 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`).

handleReference

The handler for idle connections.

Indicates whether this pool is shut down.

References to issued connections. Objects in this set are of class BasicPoolEntryRef, and point to the pool entry for the issued connection. GCed connections are detected by the missing pool entries.

The current total number of connections.

The global lock for this pool.

A reference queue to track loss of pool entries to GC. The same queue is used to track loss of the connection manager, so we cannot specialize the type.

Creates a new connection pool.

Closes idle connections.

idletime	the time the connections should have been idle in order to be closed now
tunit	the unit for the `idletime`

Deletes all entries for closed connections.

Enables connection garbage collection (GC). This method must be called immediately after creating the connection pool. It is not possible to enable connection GC after pool entries have been created. Neither is it possible to disable connection GC.

IllegalStateException	if connection GC is already enabled, or if it cannot be enabled because there already are pool entries

Returns an entry into the pool. The connection of the entry is expected to be in a suitable state, either open and re-usable, or closed. The pool will not make any attempt to determine whether it can be re-used or not.

entry	the entry for the connection to release
reusable	`true` if the entry is deemed reusable, `false` otherwise.
validDuration	The duration that the entry should remain free and reusable.
timeUnit	The unit of time the duration is measured in.

Obtains a pool entry with a connection within the given timeout.

route	the route for which to get the connection
timeout	the timeout, 0 or negative for no timeout
tunit	the unit for the `timeout`, may be `null` only if there is no timeout

pool entry holding a connection for the route

ConnectionPoolTimeoutException	if the timeout expired
InterruptedException	if the calling thread was interrupted

Returns a new PoolEntryRequest, from which a BasicPoolEntry can be obtained, or the request can be aborted.

Shuts down this pool and all associated resources. Overriding methods MUST call the implementation here!

Closes a connection from this pool.

conn	the connection to close, or `null`

Handles cleaning up for a lost pool entry with the given route. A lost pool entry corresponds to a connection that was garbage collected instead of being properly released.

route	the route of the pool entry that was lost

Build 110632-110632 - 22 Sep 2008 13:34

					void	handleReference(Reference<?> ref)
						Invoked when a reference is found on the queue.

closeConnection(OperatedClientConnection conn)

Closes a connection from this pool.

handleLostEntry(HttpRoute route)

Handles cleaning up for a lost pool entry with the given route.