com.ibm.cloud.objectstorage.http.timers.request

Class HttpRequestTimer

java.lang.Object

com.ibm.cloud.objectstorage.http.timers.request.HttpRequestTimer

@ThreadSafe
public class HttpRequestTimer
extends Object

Represents a timer class to enforce HTTP request timeouts.

Constructor Summary

Constructors

Constructor and Description
HttpRequestTimer()

Method Summary

Modifier and Type	Method and Description
ScheduledThreadPoolExecutor	getExecutor() This method is current exposed for testing purposes
void	shutdown() Shutdown the underlying ScheduledThreadPoolExecutor.
HttpRequestAbortTaskTracker	startTimer(org.apache.http.client.methods.HttpRequestBase apacheRequest, int requestTimeoutMillis) Start the timer with the specified timeout and return a object that can be used to track the state of the timer and cancel it if need be.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestTimer

public HttpRequestTimer()

Method Detail

startTimer

public HttpRequestAbortTaskTracker startTimer(org.apache.http.client.methods.HttpRequestBase apacheRequest,
                                              int requestTimeoutMillis)

Start the timer with the specified timeout and return a object that can be used to track the state of the timer and cancel it if need be.

Parameters:

apacheRequest - HTTP request this timer will abort if triggered.

requestTimeoutMillis - A positive value here enables the timer, a non-positive value disables it and returns a dummy tracker task

Returns:

Implementation of HttpRequestAbortTaskTrackerImpl to query the state of the task and cancel it if appropriate

shutdown

public void shutdown()

Shutdown the underlying ScheduledThreadPoolExecutor. Should be invoked when AmazonHttpClient is shutdown

getExecutor

public ScheduledThreadPoolExecutor getExecutor()

This method is current exposed for testing purposes

Returns:

The underlying ScheduledThreadPoolExecutor