@Beta public final class SimpleTimeLimiter extends Object implements TimeLimiter
ExecutorService. If the time limit expires for a given method call,
the thread running the call will be interrupted.| Constructor and Description |
|---|
SimpleTimeLimiter()
Constructs a TimeLimiter instance using a
Executors.newCachedThreadPool() to execute proxied method calls. |
SimpleTimeLimiter(ExecutorService executor)
Constructs a TimeLimiter instance using the given executor service to
execute proxied method calls.
|
| Modifier and Type | Method and Description |
|---|---|
<T> T |
callWithTimeout(Callable<T> callable,
long timeoutDuration,
TimeUnit timeoutUnit,
boolean amInterruptible)
Invokes a specified Callable, timing out after the specified time limit.
|
<T> T |
newProxy(T target,
Class<T> interfaceType,
long timeoutDuration,
TimeUnit timeoutUnit)
Returns an instance of
interfaceType that delegates all method
calls to the target object, enforcing the specified time limit on
each call. |
public SimpleTimeLimiter(ExecutorService executor)
Warning: using a bounded executor may be counterproductive! If the thread pool fills up, any time callers spend waiting for a thread may count toward their time limit, and in this case the call may even time out before the target method is ever invoked.
executor - the ExecutorService that will execute the method calls on
the target objects; for example, a Executors.newCachedThreadPool().public SimpleTimeLimiter()
Executors.newCachedThreadPool() to execute proxied method calls.
Warning: using a bounded executor may be counterproductive! If the thread pool fills up, any time callers spend waiting for a thread may count toward their time limit, and in this case the call may even time out before the target method is ever invoked.
public <T> T newProxy(T target, Class<T> interfaceType, long timeoutDuration, TimeUnit timeoutUnit)
TimeLimiterinterfaceType that delegates all method
calls to the target object, enforcing the specified time limit on
each call. This time-limited delegation is also performed for calls to
Object.equals(java.lang.Object), Object.hashCode(), and
Object.toString().
If the target method call finishes before the limit is reached, the return
value or exception is propagated to the caller exactly as-is. If, on the
other hand, the time limit is reached, the proxy will attempt to abort the
call to the target, and will throw an UncheckedTimeoutException to
the caller.
It is important to note that the primary purpose of the proxy object is to return control to the caller when the timeout elapses; aborting the target method call is of secondary concern. The particular nature and strength of the guarantees made by the proxy is implementation-dependent. However, it is important that each of the methods on the target object behaves appropriately when its thread is interrupted.
newProxy in interface TimeLimitertarget - the object to proxyinterfaceType - the interface you wish the returned proxy to
implementtimeoutDuration - with timeoutUnit, the maximum length of time that
callers are willing to wait on each method call to the proxytimeoutUnit - with timeoutDuration, the maximum length of time that
callers are willing to wait on each method call to the proxypublic <T> T callWithTimeout(Callable<T> callable, long timeoutDuration, TimeUnit timeoutUnit, boolean amInterruptible) throws Exception
TimeLimiterUncheckedTimeoutException to the caller.
Warning: The future of this method is in doubt. It may be nuked, or changed significantly.
callWithTimeout in interface TimeLimitercallable - the Callable to executetimeoutDuration - with timeoutUnit, the maximum length of time to waittimeoutUnit - with timeoutDuration, the maximum length of time to waitamInterruptible - whether to respond to thread interruption by aborting
the operation and throwing InterruptedException; if false, the
operation is allowed to complete or time out, and the current thread's
interrupt status is re-asserted.InterruptedException - if interruptible is true and our
thread is interrupted during executionUncheckedTimeoutException - if the time limit is reachedExceptionCopyright © 2010-2014. All Rights Reserved.