org.apache.commons.httpclient.util

Class IdleConnectionTimeoutThread

public class IdleConnectionTimeoutThread extends Thread

A utility class for periodically closing idle connections.

Since: 3.0

See Also:

Constructor Summary
IdleConnectionTimeoutThread()
Method Summary
voidaddConnectionManager(HttpConnectionManager connectionManager)
Adds a connection manager to be handled by this class. HttpConnectionManager will be called on the connection manager every timeoutInterval milliseconds.
voidremoveConnectionManager(HttpConnectionManager connectionManager)
Removes the connection manager from this class.
voidrun()
Closes idle connections.
voidsetConnectionTimeout(long connectionTimeout)
Sets the timeout value to use when testing for idle connections.
voidsetTimeoutInterval(long timeoutInterval)
Sets the interval used by this class between closing idle connections.
voidshutdown()
Stops the thread used to close idle connections.

Constructor Detail

IdleConnectionTimeoutThread

public IdleConnectionTimeoutThread()

Method Detail

addConnectionManager

public void addConnectionManager(HttpConnectionManager connectionManager)
Adds a connection manager to be handled by this class. HttpConnectionManager will be called on the connection manager every timeoutInterval milliseconds.

Parameters: connectionManager The connection manager to add

removeConnectionManager

public void removeConnectionManager(HttpConnectionManager connectionManager)
Removes the connection manager from this class. The idle connections from the connection manager will no longer be automatically closed by this class.

Parameters: connectionManager The connection manager to remove

run

public void run()
Closes idle connections.

setConnectionTimeout

public void setConnectionTimeout(long connectionTimeout)
Sets the timeout value to use when testing for idle connections.

Parameters: connectionTimeout The connection timeout in milliseconds

See Also: HttpConnectionManager

setTimeoutInterval

public void setTimeoutInterval(long timeoutInterval)
Sets the interval used by this class between closing idle connections. Idle connections will be closed every timeoutInterval milliseconds.

Parameters: timeoutInterval The timeout interval in milliseconds

shutdown

public void shutdown()
Stops the thread used to close idle connections. This class cannot be used once shutdown.
Copyright (c) 1999-2005 - Apache Software Foundation