Interface TimeLimiter
-
- All Known Implementing Classes:
FakeTimeLimiter
,SimpleTimeLimiter
@DoNotMock("Use FakeTimeLimiter") @GwtIncompatible public interface TimeLimiter
Imposes a time limit on method calls.- Since:
- 1.0
- Author:
- Kevin Bourrillion, Jens Nyman
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description <T extends @Nullable java.lang.Object>
TcallUninterruptiblyWithTimeout(java.util.concurrent.Callable<T> callable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Invokes a specified Callable, timing out after the specified time limit.default <T extends @Nullable java.lang.Object>
TcallUninterruptiblyWithTimeout(java.util.concurrent.Callable<T> callable, java.time.Duration timeout)
Invokes a specified Callable, timing out after the specified time limit.<T extends @Nullable java.lang.Object>
TcallWithTimeout(java.util.concurrent.Callable<T> callable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Invokes a specified Callable, timing out after the specified time limit.default <T extends @Nullable java.lang.Object>
TcallWithTimeout(java.util.concurrent.Callable<T> callable, java.time.Duration timeout)
Invokes a specified Callable, timing out after the specified time limit.<T> T
newProxy(T target, java.lang.Class<T> interfaceType, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Returns an instance ofinterfaceType
that delegates all method calls to thetarget
object, enforcing the specified time limit on each call.default <T> T
newProxy(T target, java.lang.Class<T> interfaceType, java.time.Duration timeout)
Returns an instance ofinterfaceType
that delegates all method calls to thetarget
object, enforcing the specified time limit on each call.void
runUninterruptiblyWithTimeout(java.lang.Runnable runnable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Invokes a specified Runnable, timing out after the specified time limit.default void
runUninterruptiblyWithTimeout(java.lang.Runnable runnable, java.time.Duration timeout)
Invokes a specified Runnable, timing out after the specified time limit.void
runWithTimeout(java.lang.Runnable runnable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Invokes a specified Runnable, timing out after the specified time limit.default void
runWithTimeout(java.lang.Runnable runnable, java.time.Duration timeout)
Invokes a specified Runnable, timing out after the specified time limit.
-
-
-
Method Detail
-
newProxy
<T> T newProxy(T target, java.lang.Class<T> interfaceType, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit)
Returns an instance ofinterfaceType
that delegates all method calls to thetarget
object, enforcing the specified time limit on each call. This time-limited delegation is also performed for calls toObject.equals(java.lang.Object)
,Object.hashCode()
, andObject.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.
For example, to return the value of
target.someMethod()
, but substituteDEFAULT_VALUE
if this method call takes over 50 ms, you can use this code:TimeLimiter limiter = . . .; TargetType proxy = limiter.newProxy( target, TargetType.class, 50, TimeUnit.MILLISECONDS); try { return proxy.someMethod(); } catch (UncheckedTimeoutException e) { return DEFAULT_VALUE; }
- Parameters:
target
- 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 proxy- Returns:
- a time-limiting proxy
- Throws:
java.lang.IllegalArgumentException
- ifinterfaceType
is a regular class, enum, or annotation type, rather than an interface
-
newProxy
default <T> T newProxy(T target, java.lang.Class<T> interfaceType, java.time.Duration timeout)
Returns an instance ofinterfaceType
that delegates all method calls to thetarget
object, enforcing the specified time limit on each call. This time-limited delegation is also performed for calls toObject.equals(java.lang.Object)
,Object.hashCode()
, andObject.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.
For example, to return the value of
target.someMethod()
, but substituteDEFAULT_VALUE
if this method call takes over 50 ms, you can use this code:TimeLimiter limiter = . . .; TargetType proxy = limiter.newProxy(target, TargetType.class, Duration.ofMillis(50)); try { return proxy.someMethod(); } catch (UncheckedTimeoutException e) { return DEFAULT_VALUE; }
- Parameters:
target
- the object to proxyinterfaceType
- the interface you wish the returned proxy to implementtimeout
- the maximum length of time that callers are willing to wait on each method call to the proxy- Returns:
- a time-limiting proxy
- Throws:
java.lang.IllegalArgumentException
- ifinterfaceType
is a regular class, enum, or annotation type, rather than an interface- Since:
- 28.0
-
callWithTimeout
@CanIgnoreReturnValue <T extends @Nullable java.lang.Object> T callWithTimeout(java.util.concurrent.Callable<T> callable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit) throws java.util.concurrent.TimeoutException, java.lang.InterruptedException, java.util.concurrent.ExecutionException
Invokes a specified Callable, timing out after the specified time limit. If the target method call finishes before the limit is reached, the return value or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the call to the target, and throw aTimeoutException
to the caller.- Parameters:
callable
- the Callable to executetimeoutDuration
- with timeoutUnit, the maximum length of time to waittimeoutUnit
- with timeoutDuration, the maximum length of time to wait- Returns:
- the result returned by the Callable
- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.lang.InterruptedException
- if the current thread was interrupted during executionjava.util.concurrent.ExecutionException
- ifcallable
throws a checked exceptionUncheckedExecutionException
- ifcallable
throws aRuntimeException
ExecutionError
- ifcallable
throws anError
- Since:
- 22.0
-
callWithTimeout
@CanIgnoreReturnValue default <T extends @Nullable java.lang.Object> T callWithTimeout(java.util.concurrent.Callable<T> callable, java.time.Duration timeout) throws java.util.concurrent.TimeoutException, java.lang.InterruptedException, java.util.concurrent.ExecutionException
Invokes a specified Callable, timing out after the specified time limit. If the target method call finishes before the limit is reached, the return value or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the call to the target, and throw aTimeoutException
to the caller.- Parameters:
callable
- the Callable to executetimeout
- the maximum length of time to wait- Returns:
- the result returned by the Callable
- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.lang.InterruptedException
- if the current thread was interrupted during executionjava.util.concurrent.ExecutionException
- ifcallable
throws a checked exceptionUncheckedExecutionException
- ifcallable
throws aRuntimeException
ExecutionError
- ifcallable
throws anError
- Since:
- 28.0
-
callUninterruptiblyWithTimeout
@CanIgnoreReturnValue <T extends @Nullable java.lang.Object> T callUninterruptiblyWithTimeout(java.util.concurrent.Callable<T> callable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit) throws java.util.concurrent.TimeoutException, java.util.concurrent.ExecutionException
Invokes a specified Callable, timing out after the specified time limit. If the target method call finishes before the limit is reached, the return value or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the call to the target, and throw aTimeoutException
to the caller.The difference with
callWithTimeout(Callable, long, TimeUnit)
is that this method will ignore interrupts on the current thread.- Parameters:
callable
- the Callable to executetimeoutDuration
- with timeoutUnit, the maximum length of time to waittimeoutUnit
- with timeoutDuration, the maximum length of time to wait- Returns:
- the result returned by the Callable
- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.util.concurrent.ExecutionException
- ifcallable
throws a checked exceptionUncheckedExecutionException
- ifcallable
throws aRuntimeException
ExecutionError
- ifcallable
throws anError
- Since:
- 22.0
-
callUninterruptiblyWithTimeout
@CanIgnoreReturnValue default <T extends @Nullable java.lang.Object> T callUninterruptiblyWithTimeout(java.util.concurrent.Callable<T> callable, java.time.Duration timeout) throws java.util.concurrent.TimeoutException, java.util.concurrent.ExecutionException
Invokes a specified Callable, timing out after the specified time limit. If the target method call finishes before the limit is reached, the return value or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the call to the target, and throw aTimeoutException
to the caller.The difference with
callWithTimeout(Callable, Duration)
is that this method will ignore interrupts on the current thread.- Parameters:
callable
- the Callable to executetimeout
- the maximum length of time to wait- Returns:
- the result returned by the Callable
- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.util.concurrent.ExecutionException
- ifcallable
throws a checked exceptionUncheckedExecutionException
- ifcallable
throws aRuntimeException
ExecutionError
- ifcallable
throws anError
- Since:
- 28.0
-
runWithTimeout
void runWithTimeout(java.lang.Runnable runnable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit) throws java.util.concurrent.TimeoutException, java.lang.InterruptedException
Invokes a specified Runnable, timing out after the specified time limit. If the target method run finishes before the limit is reached, this method returns or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the run, and throw aTimeoutException
to the caller.- Parameters:
runnable
- the Runnable to executetimeoutDuration
- with timeoutUnit, the maximum length of time to waittimeoutUnit
- with timeoutDuration, the maximum length of time to wait- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.lang.InterruptedException
- if the current thread was interrupted during executionUncheckedExecutionException
- ifrunnable
throws aRuntimeException
ExecutionError
- ifrunnable
throws anError
- Since:
- 22.0
-
runWithTimeout
default void runWithTimeout(java.lang.Runnable runnable, java.time.Duration timeout) throws java.util.concurrent.TimeoutException, java.lang.InterruptedException
Invokes a specified Runnable, timing out after the specified time limit. If the target method run finishes before the limit is reached, this method returns or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the run, and throw aTimeoutException
to the caller.- Parameters:
runnable
- the Runnable to executetimeout
- the maximum length of time to wait- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedjava.lang.InterruptedException
- if the current thread was interrupted during executionUncheckedExecutionException
- ifrunnable
throws aRuntimeException
ExecutionError
- ifrunnable
throws anError
- Since:
- 28.0
-
runUninterruptiblyWithTimeout
void runUninterruptiblyWithTimeout(java.lang.Runnable runnable, long timeoutDuration, java.util.concurrent.TimeUnit timeoutUnit) throws java.util.concurrent.TimeoutException
Invokes a specified Runnable, timing out after the specified time limit. If the target method run finishes before the limit is reached, this method returns or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the run, and throw aTimeoutException
to the caller.The difference with
runWithTimeout(Runnable, long, TimeUnit)
is that this method will ignore interrupts on the current thread.- Parameters:
runnable
- the Runnable to executetimeoutDuration
- with timeoutUnit, the maximum length of time to waittimeoutUnit
- with timeoutDuration, the maximum length of time to wait- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedUncheckedExecutionException
- ifrunnable
throws aRuntimeException
ExecutionError
- ifrunnable
throws anError
- Since:
- 22.0
-
runUninterruptiblyWithTimeout
default void runUninterruptiblyWithTimeout(java.lang.Runnable runnable, java.time.Duration timeout) throws java.util.concurrent.TimeoutException
Invokes a specified Runnable, timing out after the specified time limit. If the target method run finishes before the limit is reached, this method returns or a wrapped exception is propagated. If, on the other hand, the time limit is reached, we attempt to abort the run, and throw aTimeoutException
to the caller.The difference with
runWithTimeout(Runnable, Duration)
is that this method will ignore interrupts on the current thread.- Parameters:
runnable
- the Runnable to executetimeout
- the maximum length of time to wait- Throws:
java.util.concurrent.TimeoutException
- if the time limit is reachedUncheckedExecutionException
- ifrunnable
throws aRuntimeException
ExecutionError
- ifrunnable
throws anError
- Since:
- 28.0
-
-