IdleConnectionHandler

A helper class for connection managers to track idle connections.

Summary

Public Constructors
	IdleConnectionHandler()

Public Constructors

IdleConnectionHandler()

Public Methods
void	add(HttpConnection connection, long validDuration, TimeUnit unit) Registers the given connection with this handler.
void	closeExpiredConnections()
void	closeIdleConnections(long idleTime) Closes connections that have been idle for at least the given amount of time.
boolean	remove(HttpConnection connection) Removes the given connection from the list of connections to be closed when idle.
void	removeAll() Removes all connections referenced by this handler.

Public Methods

void

add(HttpConnection connection, long validDuration, TimeUnit unit)

Registers the given connection with this handler.

void

closeExpiredConnections()

void

closeIdleConnections(long idleTime)

Closes connections that have been idle for at least the given amount of time.

boolean

remove(HttpConnection connection)

Removes the given connection from the list of connections to be closed when idle.

void

removeAll()

Removes all connections referenced by this handler.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public void add (HttpConnection connection, long validDuration, TimeUnit unit)

Since: API Level 1

Registers the given connection with this handler. The connection will be held until remove(HttpConnection) or closeIdleConnections(long) is called.

Parameters

connection	the connection to add

public void closeExpiredConnections ()

Since: API Level 1

public void closeIdleConnections (long idleTime)

Since: API Level 1

Closes connections that have been idle for at least the given amount of time.

Parameters

idleTime	the minimum idle time, in milliseconds, for connections to be closed

public boolean remove (HttpConnection connection)

Since: API Level 1

Removes the given connection from the list of connections to be closed when idle. This will return true if the connection is still valid, and false if the connection should be considered expired and not used.

Returns

True if the connection is still valid.

public void removeAll ()

Since: API Level 1

Removes all connections referenced by this handler.

Results

Classes

Class Overview

See Also

Summary

Public Constructors

public IdleConnectionHandler ()

Public Methods

public void add (HttpConnection connection, long validDuration, TimeUnit unit)

Parameters

See Also

public void closeExpiredConnections ()

public void closeIdleConnections (long idleTime)

Parameters

public boolean remove (HttpConnection connection)

Returns

public void removeAll ()

java.lang.Object
↳	org.apache.http.impl.conn.IdleConnectionHandler