org.restlet.ext.httpclient.internal

Class HttpIdleConnectionReaper

java.lang.Object

org.restlet.ext.httpclient.internal.HttpIdleConnectionReaper

Deprecated.

Will be removed to favor lower-level network extensions allowing more control at the Restlet API level.

@Deprecated
public class HttpIdleConnectionReaper
extends Object

Class that embodies a Reaper thread that reaps idle connections. Note that the thread won't be started if the value of the idleCheckInterval parameter is equal to 0.

Author:

Sanjay Acharya

Constructor Summary

Constructors

Constructor and Description
HttpIdleConnectionReaper(org.apache.http.client.HttpClient httpClient, long idleCheckInterval, long idleTimeout) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isStarted() Deprecated. Returns true if the reaper is started.
boolean	isStopped() Deprecated. Returns true if the reaper is stopped.
void	stop() Deprecated. Stops the Idle Connection Reaper if running.
void	waitForReaperStart(long millis) Deprecated. Tells the reaper thread the maximum time to wait before starting.
void	waitForReaperStop(long millis) Deprecated. Tells the reaper thread the maximum time to wait before stopping.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpIdleConnectionReaper

public HttpIdleConnectionReaper(org.apache.http.client.HttpClient httpClient,
                                long idleCheckInterval,
                                long idleTimeout)

Deprecated.

Constructor.

Parameters:

httpClient - The HttpClient for which this is the reaper.

idleCheckInterval - The time to sleep between checks for idle connections. Note that if this is 0, then reaping won't occur.

idleTimeout - The age of connections to reap.

Method Detail

isStarted

public boolean isStarted()

Deprecated.

Returns true if the reaper is started.

Returns:

true If the reaper is started.

isStopped

public boolean isStopped()

Deprecated.

Returns true if the reaper is stopped.

Returns:

true if the reaper is stopped.

stop

public void stop()
          throws InterruptedException

Deprecated.

Stops the Idle Connection Reaper if running.

Throws:

InterruptedException - If the call to stop was interrupted

waitForReaperStart

public void waitForReaperStart(long millis)
                        throws InterruptedException

Deprecated.

Tells the reaper thread the maximum time to wait before starting.

Parameters:

millis - The maximum time to wait before starting the thread.

Throws:

InterruptedException - If the current thread was interrupted.

waitForReaperStop

public void waitForReaperStop(long millis)
                       throws InterruptedException

Deprecated.

Tells the reaper thread the maximum time to wait before stopping.

Parameters:

millis - The maximum time to wait before stopping the thread.

Throws:

InterruptedException - If the current thread was interrupted.